Restructure README.md
This commit is contained in:
David Yun
parent
497dfd95a9
commit
36ab8b912a
516
README.md
516
README.md
@ -1,253 +1,263 @@
|
|||||||
IK Analysis for ElasticSearch
|
IK Analysis for ElasticSearch
|
||||||
==================================
|
=============================
|
||||||
|
|
||||||
更新说明：
|
The IK Analysis plugin integrates Lucene IK analyzer into elasticsearch, support customized dictionary.
|
||||||
对于使用es集群，用ik作为分词插件，经常会修改自定义词典，增加远程加载，每次更新都会重新加载词典，不必重启es服务。
|
|
||||||
|
Tokenizer: `ik`
|
||||||
The IK Analysis plugin integrates Lucene IK analyzer into elasticsearch, support customized dictionary.
|
|
||||||
|
更新：对于使用 ES 集群，用 IK 作为分词插件，经常会修改自定义词典的使用者，可以透过远程加载的方式，每次更新都会重新加载词典，不必重启 ES 服务。
|
||||||
Tokenizer: `ik`
|
|
||||||
|
Versions
|
||||||
Version
|
--------
|
||||||
-------------
|
|
||||||
master | 1.5.0 -> master
|
IK version | ES version
|
||||||
1.4.0 | 1.6.0
|
-----------|-----------
|
||||||
1.3.0 | 1.5.0
|
master | 1.5.0 -> master
|
||||||
1.2.9 | 1.4.0
|
1.4.0 | 1.6.0
|
||||||
1.2.8 | 1.3.2
|
1.3.0 | 1.5.0
|
||||||
1.2.7 | 1.2.1
|
1.2.9 | 1.4.0
|
||||||
1.2.6 | 1.0.0
|
1.2.8 | 1.3.2
|
||||||
1.2.5 | 0.90.2
|
1.2.7 | 1.2.1
|
||||||
1.2.3 | 0.90.2
|
1.2.6 | 1.0.0
|
||||||
1.2.0 | 0.90.0
|
1.2.5 | 0.90.2
|
||||||
1.1.3 | 0.20.2
|
1.2.3 | 0.90.2
|
||||||
1.1.2 | 0.19.x
|
1.2.0 | 0.90.0
|
||||||
1.0.0 | 0.16.2 -> 0.19.0
|
1.1.3 | 0.20.2
|
||||||
|
1.1.2 | 0.19.x
|
||||||
Thanks
|
1.0.0 | 0.16.2 -> 0.19.0
|
||||||
-------------
|
|
||||||
YourKit supports IK Analysis for ElasticSearch project with its full-featured Java Profiler.
|
Install
|
||||||
YourKit, LLC is the creator of innovative and intelligent tools for profiling
|
-------
|
||||||
Java and .NET applications. Take a look at YourKit's leading software products:
|
|
||||||
<a href="http://www.yourkit.com/java/profiler/index.jsp">YourKit Java Profiler</a> and
|
you can download this plugin from RTF project(https://github.com/medcl/elasticsearch-rtf)
|
||||||
<a href="http://www.yourkit.com/.net/profiler/index.jsp">YourKit .NET Profiler</a>.
|
https://github.com/medcl/elasticsearch-rtf/tree/master/plugins/analysis-ik
|
||||||
|
https://github.com/medcl/elasticsearch-rtf/tree/master/config/ik
|
||||||
Install
|
|
||||||
-------------
|
<del>also remember to download the dict files,unzip these dict file into your elasticsearch's config folder,such as: your-es-root/config/ik</del>
|
||||||
you can download this plugin from RTF project(https://github.com/medcl/elasticsearch-rtf)
|
|
||||||
https://github.com/medcl/elasticsearch-rtf/tree/master/plugins/analysis-ik
|
you need a service restart after that!
|
||||||
https://github.com/medcl/elasticsearch-rtf/tree/master/config/ik
|
|
||||||
|
Configuration
|
||||||
<del>also remember to download the dict files,unzip these dict file into your elasticsearch's config folder,such as: your-es-root/config/ik</del>
|
-------------
|
||||||
|
|
||||||
you need a service restart after that!
|
### Analysis Configuration
|
||||||
|
|
||||||
Dict Configuration (es-root/config/ik/IKAnalyzer.cfg.xml)
|
#### `elasticsearch.yml`
|
||||||
-------------
|
|
||||||
|
```yaml
|
||||||
https://github.com/medcl/elasticsearch-analysis-ik/blob/master/config/ik/IKAnalyzer.cfg.xml
|
index:
|
||||||
|
analysis:
|
||||||
<pre>
|
analyzer:
|
||||||
|
ik:
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
alias: [ik_analyzer]
|
||||||
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
|
type: org.elasticsearch.index.analysis.IkAnalyzerProvider
|
||||||
<properties>
|
ik_max_word:
|
||||||
<comment>IK Analyzer 扩展配置</comment>
|
type: ik
|
||||||
<!--用户可以在这里配置自己的扩展字典 -->
|
use_smart: false
|
||||||
<entry key="ext_dict">custom/mydict.dic;custom/single_word_low_freq.dic</entry>
|
ik_smart:
|
||||||
<!--用户可以在这里配置自己的扩展停止词字典-->
|
type: ik
|
||||||
<entry key="ext_stopwords">custom/ext_stopword.dic</entry>
|
use_smart: true
|
||||||
<!--用户可以在这里配置远程扩展字典 -->
|
```
|
||||||
<entry key="remote_ext_dict">location</entry>
|
|
||||||
<!--用户可以在这里配置远程扩展停止词字典-->
|
Or
|
||||||
<entry key="remote_ext_stopwords">location</entry>
|
|
||||||
</properties>
|
```yaml
|
||||||
|
index.analysis.analyzer.ik.type : "ik"
|
||||||
</pre>
|
```
|
||||||
|
|
||||||
Analysis Configuration (elasticsearch.yml)
|
you can set your prefer segment mode,default `use_smart` is false.
|
||||||
-------------
|
|
||||||
|
### Mapping Configuration
|
||||||
<pre>
|
|
||||||
index:
|
#### Quick Example
|
||||||
analysis:
|
|
||||||
analyzer:
|
1. create a index
|
||||||
ik:
|
|
||||||
alias: [ik_analyzer]
|
```bash
|
||||||
type: org.elasticsearch.index.analysis.IkAnalyzerProvider
|
curl -XPUT http://localhost:9200/index
|
||||||
ik_max_word:
|
```
|
||||||
type: ik
|
|
||||||
use_smart: false
|
2. create a mapping
|
||||||
ik_smart:
|
|
||||||
type: ik
|
```bash
|
||||||
use_smart: true
|
curl -XPOST http://localhost:9200/index/fulltext/_mapping -d'
|
||||||
</pre>
|
{
|
||||||
Or
|
"fulltext": {
|
||||||
<pre>
|
"_all": {
|
||||||
index.analysis.analyzer.ik.type : "ik"
|
"indexAnalyzer": "ik",
|
||||||
</pre>
|
"searchAnalyzer": "ik",
|
||||||
|
"term_vector": "no",
|
||||||
you can set your prefer segment mode,default `use_smart` is false.
|
"store": "false"
|
||||||
|
},
|
||||||
Mapping Configuration
|
"properties": {
|
||||||
-------------
|
"content": {
|
||||||
|
"type": "string",
|
||||||
Here is a quick example:
|
"store": "no",
|
||||||
1.create a index
|
"term_vector": "with_positions_offsets",
|
||||||
|
"indexAnalyzer": "ik",
|
||||||
<pre>
|
"searchAnalyzer": "ik",
|
||||||
|
"include_in_all": "true",
|
||||||
curl -XPUT http://localhost:9200/index
|
"boost": 8
|
||||||
|
}
|
||||||
</pre>
|
}
|
||||||
|
}
|
||||||
2.create a mapping
|
}'
|
||||||
|
```
|
||||||
<pre>
|
|
||||||
|
3. index some docs
|
||||||
curl -XPOST http://localhost:9200/index/fulltext/_mapping -d'
|
|
||||||
{
|
```bash
|
||||||
"fulltext": {
|
curl -XPOST http://localhost:9200/index/fulltext/1 -d'
|
||||||
"_all": {
|
{"content":"美国留给伊拉克的是个烂摊子吗"}
|
||||||
"indexAnalyzer": "ik",
|
'
|
||||||
"searchAnalyzer": "ik",
|
```
|
||||||
"term_vector": "no",
|
|
||||||
"store": "false"
|
```bash
|
||||||
},
|
curl -XPOST http://localhost:9200/index/fulltext/2 -d'
|
||||||
"properties": {
|
{"content":"公安部：各地校车将享最高路权"}
|
||||||
"content": {
|
'
|
||||||
"type": "string",
|
```
|
||||||
"store": "no",
|
|
||||||
"term_vector": "with_positions_offsets",
|
```bash
|
||||||
"indexAnalyzer": "ik",
|
curl -XPOST http://localhost:9200/index/fulltext/3 -d'
|
||||||
"searchAnalyzer": "ik",
|
{"content":"中韩渔警冲突调查：韩警平均每天扣1艘中国渔船"}
|
||||||
"include_in_all": "true",
|
'
|
||||||
"boost": 8
|
```
|
||||||
}
|
|
||||||
}
|
```bash
|
||||||
}
|
curl -XPOST http://localhost:9200/index/fulltext/4 -d'
|
||||||
}'
|
{"content":"中国驻洛杉矶领事馆遭亚裔男子枪击 嫌犯已自首"}
|
||||||
</pre>
|
'
|
||||||
|
```
|
||||||
3.index some docs
|
|
||||||
|
4. query with highlighting
|
||||||
<pre>
|
|
||||||
|
```bash
|
||||||
curl -XPOST http://localhost:9200/index/fulltext/1 -d'
|
curl -XPOST http://localhost:9200/index/fulltext/_search -d'
|
||||||
{"content":"美国留给伊拉克的是个烂摊子吗"}
|
{
|
||||||
'
|
"query" : { "term" : { "content" : "中国" }},
|
||||||
|
"highlight" : {
|
||||||
curl -XPOST http://localhost:9200/index/fulltext/2 -d'
|
"pre_tags" : ["<tag1>", "<tag2>"],
|
||||||
{"content":"公安部：各地校车将享最高路权"}
|
"post_tags" : ["</tag1>", "</tag2>"],
|
||||||
'
|
"fields" : {
|
||||||
|
"content" : {}
|
||||||
curl -XPOST http://localhost:9200/index/fulltext/3 -d'
|
}
|
||||||
{"content":"中韩渔警冲突调查：韩警平均每天扣1艘中国渔船"}
|
}
|
||||||
'
|
}
|
||||||
|
'
|
||||||
curl -XPOST http://localhost:9200/index/fulltext/4 -d'
|
```
|
||||||
{"content":"中国驻洛杉矶领事馆遭亚裔男子枪击 嫌犯已自首"}
|
|
||||||
'
|
#### Result
|
||||||
</pre>
|
|
||||||
|
```json
|
||||||
4.query with highlighting
|
{
|
||||||
|
"took": 14,
|
||||||
<pre>
|
"timed_out": false,
|
||||||
|
"_shards": {
|
||||||
curl -XPOST http://localhost:9200/index/fulltext/_search -d'
|
"total": 5,
|
||||||
{
|
"successful": 5,
|
||||||
"query" : { "term" : { "content" : "中国" }},
|
"failed": 0
|
||||||
"highlight" : {
|
},
|
||||||
"pre_tags" : ["<tag1>", "<tag2>"],
|
"hits": {
|
||||||
"post_tags" : ["</tag1>", "</tag2>"],
|
"total": 2,
|
||||||
"fields" : {
|
"max_score": 2,
|
||||||
"content" : {}
|
"hits": [
|
||||||
}
|
{
|
||||||
}
|
"_index": "index",
|
||||||
}
|
"_type": "fulltext",
|
||||||
'
|
"_id": "4",
|
||||||
</pre>
|
"_score": 2,
|
||||||
|
"_source": {
|
||||||
here is the query result
|
"content": "中国驻洛杉矶领事馆遭亚裔男子枪击 嫌犯已自首"
|
||||||
|
},
|
||||||
<pre>
|
"highlight": {
|
||||||
|
"content": [
|
||||||
{
|
"<tag1>中国</tag1>驻洛杉矶领事馆遭亚裔男子枪击 嫌犯已自首 "
|
||||||
"took": 14,
|
]
|
||||||
"timed_out": false,
|
}
|
||||||
"_shards": {
|
},
|
||||||
"total": 5,
|
{
|
||||||
"successful": 5,
|
"_index": "index",
|
||||||
"failed": 0
|
"_type": "fulltext",
|
||||||
},
|
"_id": "3",
|
||||||
"hits": {
|
"_score": 2,
|
||||||
"total": 2,
|
"_source": {
|
||||||
"max_score": 2,
|
"content": "中韩渔警冲突调查：韩警平均每天扣1艘中国渔船"
|
||||||
"hits": [
|
},
|
||||||
{
|
"highlight": {
|
||||||
"_index": "index",
|
"content": [
|
||||||
"_type": "fulltext",
|
"均每天扣1艘<tag1>中国</tag1>渔船 "
|
||||||
"_id": "4",
|
]
|
||||||
"_score": 2,
|
}
|
||||||
"_source": {
|
}
|
||||||
"content": "中国驻洛杉矶领事馆遭亚裔男子枪击 嫌犯已自首"
|
]
|
||||||
},
|
}
|
||||||
"highlight": {
|
}
|
||||||
"content": [
|
```
|
||||||
"<tag1>中国</tag1>驻洛杉矶领事馆遭亚裔男子枪击 嫌犯已自首 "
|
|
||||||
]
|
### Dictionary Configuration
|
||||||
}
|
|
||||||
},
|
#### `config/ik/IKAnalyzer.cfg.xml`
|
||||||
{
|
|
||||||
"_index": "index",
|
```xml
|
||||||
"_type": "fulltext",
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
"_id": "3",
|
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
|
||||||
"_score": 2,
|
<properties>
|
||||||
"_source": {
|
<comment>IK Analyzer 扩展配置</comment>
|
||||||
"content": "中韩渔警冲突调查：韩警平均每天扣1艘中国渔船"
|
<!--用户可以在这里配置自己的扩展字典 -->
|
||||||
},
|
<entry key="ext_dict">custom/mydict.dic;custom/single_word_low_freq.dic</entry>
|
||||||
"highlight": {
|
<!--用户可以在这里配置自己的扩展停止词字典-->
|
||||||
"content": [
|
<entry key="ext_stopwords">custom/ext_stopword.dic</entry>
|
||||||
"均每天扣1艘<tag1>中国</tag1>渔船 "
|
<!--用户可以在这里配置远程扩展字典 -->
|
||||||
]
|
<entry key="remote_ext_dict">location</entry>
|
||||||
}
|
<!--用户可以在这里配置远程扩展停止词字典-->
|
||||||
}
|
<entry key="remote_ext_stopwords">location</entry>
|
||||||
]
|
</properties>
|
||||||
}
|
```
|
||||||
}
|
|
||||||
|
### 热更新 IK 分词使用方法
|
||||||
</pre>
|
|
||||||
|
目前该插件支持热更新 IK 分词，通过上文在 IK 配置文件中提到的如下配置
|
||||||
have fun.
|
|
||||||
|
```xml
|
||||||
热更新IK分词使用方法
|
<!--用户可以在这里配置远程扩展字典 -->
|
||||||
----------
|
<entry key="remote_ext_dict">location</entry>
|
||||||
目前该插件支持热更新 ik 分词，通过上文在 ik 配置文件中提到的如下配置
|
<!--用户可以在这里配置远程扩展停止词字典-->
|
||||||
|
<entry key="remote_ext_stopwords">location</entry>
|
||||||
<pre>
|
```
|
||||||
<!--用户可以在这里配置远程扩展字典 -->
|
|
||||||
<entry key="remote_ext_dict">location</entry>
|
其中 `location` 是指一个 url，比如 `http://yoursite.com/getCustomDict`，该请求只需满足以下两点即可完成分词热更新。
|
||||||
<!--用户可以在这里配置远程扩展停止词字典-->
|
|
||||||
<entry key="remote_ext_stopwords">location</entry>
|
1. 该 http 请求需要返回两个头部(header)，一个是 `Last-Modified`，一个是 `ETags`，这两者都是字符串类型，只要有一个发生变化，该插件就会去抓取新的分词进而更新词库。
|
||||||
</pre>
|
|
||||||
|
2. 该 http 请求返回的内容格式是一行一个分词，换行符用 `\n` 即可。
|
||||||
其中 `location` 是指一个 url，比如 `http://yoursite.com/getCustomDict`，该请求只需满足一下两点即可完成分词热更新。
|
|
||||||
|
满足上面两点要求就可以实现热更新分词了，不需要重启 ES 实例。
|
||||||
1. 该 http 请求需要返回两个头部，一个是 `Last-Modified`，一个是 `ETags`，这两者都是字符串类型，只要有一个发生变化，该插件就会去抓取新的分词进而更新词库。
|
|
||||||
|
have fun.
|
||||||
2. 该 http 请求返回的内容格式是一行一个分词，换行符用 `\n` 即可。
|
|
||||||
|
常见问题
|
||||||
满足上面两点要求就可以实现热更新分词了，不需要重启 es 实例。
|
-------
|
||||||
|
|
||||||
常见问题：
|
1.自定义词典为什么没有生效？
|
||||||
-------------
|
|
||||||
1.自定义词典为什么没有生效？
|
请确保你的扩展词典的文本格式为 UTF8 编码
|
||||||
请确保你的扩展词典的文本格式为 UTF8 编码
|
|
||||||
|
2.如何手动安装，以 1.3.0 為例？（参考：https://github.com/medcl/elasticsearch-analysis-ik/issues/46）
|
||||||
2.如何手动安装，以 1.3.0 為例？（参考：https://github.com/medcl/elasticsearch-analysis-ik/issues/46）
|
|
||||||
|
|
||||||
`git clone https://github.com/medcl/elasticsearch-analysis-ik`
|
```bash
|
||||||
`cd elasticsearch-analysis-ik`
|
git clone https://github.com/medcl/elasticsearch-analysis-ik
|
||||||
`mvn compile`
|
cd elasticsearch-analysis-ik
|
||||||
`mvn package`
|
mvn compile
|
||||||
`plugin --install analysis-ik --url file:///#{project_path}/elasticsearch-analysis-ik/target/releases/elasticsearch-analysis-ik-1.3.0.zip`
|
mvn package
|
||||||
|
plugin --install analysis-ik --url file:///#{project_path}/elasticsearch-analysis-ik/target/releases/elasticsearch-analysis-ik-1.3.0.zip
|
||||||
|
```
|
||||||
|
|
||||||
|
Thanks
|
||||||
|
------
|
||||||
|
YourKit supports IK Analysis for ElasticSearch project with its full-featured Java Profiler.
|
||||||
|
YourKit, LLC is the creator of innovative and intelligent tools for profiling
|
||||||
|
Java and .NET applications. Take a look at YourKit's leading software products:
|
||||||
|
<a href="http://www.yourkit.com/java/profiler/index.jsp">YourKit Java Profiler</a> and
|
||||||
|
<a href="http://www.yourkit.com/.net/profiler/index.jsp">YourKit .NET Profiler</a>.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user