Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hankcs/hanlp-lucene-plugin
HanLP中文分词Lucene插件，支持包括Solr在内的基于Lucene的系统
https://github.com/hankcs/hanlp-lucene-plugin
chinese-text-segmentation hanlp lucene nlp solr traditional-chinese
Last synced: 17 days ago
JSON representation
HanLP中文分词Lucene插件，支持包括Solr在内的基于Lucene的系统
- Host: GitHub
- URL: https://github.com/hankcs/hanlp-lucene-plugin
- Owner: hankcs
- License: apache-2.0
- Created: 2015-08-22T14:23:27.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-10-13T09:04:23.000Z (about 4 years ago)
- Last Synced: 2024-10-14T12:18:57.964Z (30 days ago)
- Topics: chinese-text-segmentation, hanlp, lucene, nlp, solr, traditional-chinese
- Language: Java
- Homepage: http://www.hankcs.com/nlp/segment/full-text-retrieval-solr-integrated-hanlp-chinese-word-segmentation.html
- Size: 73.2 KB
- Stars: 296
- Watchers: 28
- Forks: 99
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
hanlp-lucene-plugin
========
HanLP中文分词Lucene插件
----------------------
基于HanLP，支持包括Solr（7.x）在内的任何基于Lucene（7.x）的系统。
## Maven
```xml
com.hankcs.nlp
hanlp-lucene-plugin
1.1.7
```
## Solr快速上手
1. 将[hanlp-portable.jar](https://search.maven.org/search?q=g:com.hankcs%20AND%20a:hanlp)和[hanlp-lucene-plugin.jar](https://github.com/hankcs/hanlp-lucene-plugin/releases)共两个jar放入```${webapp}/WEB-INF/lib```下。（或者使用```mvn package```对源码打包，拷贝```target/hanlp-lucene-plugin-x.x.x.jar```到```${webapp}/WEB-INF/lib```下）
1. 修改solr core的配置文件```${core}/conf/schema.xml```：
```xml
```
* 如果你的业务系统中有其他字段，比如location，summary之类，也需要一一指定其type="text_cn"。切记，否则这些字段仍旧是solr默认分词器。
* 另外，切记不要在query中开启indexMode，否则会影响PhaseQuery。indexMode只需在index中开启一遍即可。
## 高级配置
目前本插件支持如下基于```schema.xml```的配置:
| 配置项名称 | 功能 | 默认值 |
| -------- | -----: | :----: |
| algorithm | [分词算法](https://github.com/hankcs/HanLP/blob/master/src/main/java/com/hankcs/hanlp/HanLP.java#L643) | viterbi |
| enableIndexMode | 设为索引模式（切勿在query中开启） | true |
| enableCustomDictionary | 是否启用用户词典 | true |
| customDictionaryPath | 用户词典路径(绝对路径或程序可以读取的相对路径,多个词典用空格隔开) | null |
| enableCustomDictionaryForcing | [用户词典高优先级](https://github.com/hankcs/HanLP/wiki/FAQ#%E4%B8%BA%E4%BB%80%E4%B9%88%E4%BF%AE%E6%94%B9%E4%BA%86%E8%AF%8D%E5%85%B8%E8%BF%98%E6%98%AF%E6%B2%A1%E6%9C%89%E6%95%88%E6%9E%9C) | false |
| stopWordDictionaryPath | 停用词词典路径 | null |
| enableNumberQuantifierRecognize | 是否启用数词和数量词识别 | true |
| enableNameRecognize | 开启人名识别 | true |
| enableTranslatedNameRecognize | 是否启用音译人名识别 | false |
| enableJapaneseNameRecognize | 是否启用日本人名识别 | false |
| enableOrganizationRecognize | 开启机构名识别 | false |
| enablePlaceRecognize | 开启地名识别 | false |
| enableNormalization | 是否执行字符正规化（繁体->简体，全角->半角，大写->小写） | false |
| enableTraditionalChineseMode | 开启精准繁体中文分词 | false |
| enableDebug | 开启调试模式 | false |
更高级的配置主要通过class path下的```hanlp.properties```进行配置，请阅读[HanLP自然语言处理包文档](https://github.com/hankcs/HanLP)以了解更多相关配置，如：
0. 用户词典
0. 词性标注
0. 简繁转换
0. ……
## 停用词与同义词
推荐利用Lucene或Solr自带的filter实现，本插件不会越俎代庖。
一个示例配置如下：
```xml
```
## 调用方法
在Query改写的时候，可以利用HanLPAnalyzer分词结果中的词性等属性，如
```java
String text = "中华人民共和国很辽阔";
for (int i = 0; i < text.length(); ++i)
{
System.out.print(text.charAt(i) + "" + i + " ");
}
System.out.println();
Analyzer analyzer = new HanLPAnalyzer();
TokenStream tokenStream = analyzer.tokenStream("field", text);
tokenStream.reset();
while (tokenStream.incrementToken())
{
CharTermAttribute attribute = tokenStream.getAttribute(CharTermAttribute.class);
// 偏移量
OffsetAttribute offsetAtt = tokenStream.getAttribute(OffsetAttribute.class);
// 距离
PositionIncrementAttribute positionAttr = tokenStream.getAttribute(PositionIncrementAttribute.class);
// 词性
TypeAttribute typeAttr = tokenStream.getAttribute(TypeAttribute.class);
System.out.printf("[%d:%d %d] %s/%s\n", offsetAtt.startOffset(), offsetAtt.endOffset(), positionAttr.getPositionIncrement(), attribute, typeAttr.type());
}
```
在另一些场景，支持以自定义的分词器（比如开启了命名实体识别的分词器、繁体中文分词器、CRF分词器等）构造HanLPTokenizer，比如：
```java
tokenizer = new HanLPTokenizer(HanLP.newSegment()
.enableJapaneseNameRecognize(true)
.enableIndexMode(true), null, false);
tokenizer.setReader(new StringReader("林志玲亮相网友:确定不是波多野结衣？"));
```
## 版权
Apache License Version 2.0