elasticsearch suggest 的几种使用-completion 的基本 使用

本文对比并实践了在Solr和Elasticsearch中使用拼写建议的功能,包括TermSuggestionBuilder和PhraseSuggestionBuilder的使用方法,并详细介绍了Lucene和Elasticsearch中suggester的不同实现及映射方式。通过代码示例展示了如何在Elasticsearch中创建带有suggester的映射、添加索引时添加提示以及获取完成建议的方法。

我们再使用solr时,可以用spellchecker进行搜索时建议。在elasticsearch中我们使用SuggestionBuilder进行拼写建议。
1.使用TermSuggestionBuilder

TermSuggestionBuilder suggest=new TermSuggestionBuilder("my-suggest-1");
            suggest.analyzer("ik").field("content").size(n).text(q).maxTermFreq(10).minDocFreq(0).suggestMode("always");
            Client client = ESServiceSingleton2.getTransportClient();
            SearchResponse response = client.prepareSearch("cms")
            .setTypes("news").setSearchType(SearchType.COUNT)
            .setSuggestText(q)
            .addSuggestion(suggest)
            .execute().actionGet();
            Suggest suggest=response.getSuggest();
List<? extends Entry<? extends Option>>  list=suggest.getSuggestion("simple").getEntries();
            for(int i=0; i<list.size();i++){
 
            List<?> options=list.get(i).getOptions();
            for(int j=0;j<options.size();j++){
            if(options.get(j) instanceof Option){
            Option op=(Option)options.get(j);
            System.out.println(op.getScore());
            System.out.println(op.getText());
 
            }
 
            }
            System.out.println(list.get(i).getText());
            }

1.使用PhraseSuggestionBuilder


//q为查询词
//n为返回建议词条长度
Suggest suggest = searchSuggest(client, q,
                        phraseSuggestion("simple").maxErrors(0.5f).field("content").analyzer("ik")
                          .addCandidateGenerator(PhraseSuggestionBuilder.candidateGenerator("content").minWordLength(1).suggestMode("always"))
                                .size(n));
 
   SearchResponse response = client.prepareSearch("cms")
            .setTypes("news").setSearchType(SearchType.COUNT)
            .setSuggestText(q)
            .addSuggestion(suggest)
            .execute().actionGet();
            Suggest suggest=response.getSuggest();
List<? extends Entry<? extends Option>>  list=suggest.getSuggestion("simple").getEntries();
            for(int i=0; i<list.size();i++){
 
            List<?> options=list.get(i).getOptions();
            for(int j=0;j<options.size();j++){
            if(options.get(j) instanceof Option){
            Option op=(Option)options.get(j);
            System.out.println(op.getScore());
            System.out.println(op.getText());
 
            }
 
            }
            System.out.println(list.get(i).getText());
            }



在lucene里面,suggest 的支持非常完善,可以随心所欲的定制; 但是在es中使用起来就没有那么方便了。 es给suggest 分类4类:term ;phrase; completion; context; 目前最新版本是es1.2.1 这一块也还在不断完善中; term suggester 是根据某词元在制定的字段中出现的频次来做出提示; phrase suggester 是给term 上做了加强; 这里不做使用方法介绍;

链接地址:http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters-term.html

剩下的是completion 、context suggester。 这两个的使用与上面个使用方法完全不一样,上面都在查询的时候根据制定字段内容来做提示,而这两种是需要在mapping 里面定制suggester字段。使用时完全匹配时提示;

completion suggester 官方文档 http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters-completion.html 文档讲解的非常全面,遗憾的是没有代码,这里把代码加上java client;

1:设置mapping 中的suggester

@Test 
public void createQucikIndecs() throws IOException{ 
XContentBuilder mapping = XContentFactory.jsonBuilder() 
.startObject() 
.startObject("pingzhuang") 
.startObject("properties") 
.startObject("id").field("type", "long").field("store", "yes").field("index", "not_analyzed").endObject() 
.startObject("name").field("type", "string").field("store", "no").field("indexAnalyzer", "ik").field("searchAnalyzer", "ik").endObject() 
.startObject("suggest").field("type","completion").field("index_analyzer","simple").field("search_analyzer","simple").field("payloads","true").endObject() 
.endObject() 
.endObject() 
.endObject(); 
ESHandler.createQuickIndices("chinamedic", "pingzhuang", mapping, "formedic"); 
}

2: 设置好了以后,在做索引的时候每次都应该添加提示

@Test 
public void addIndex(){ 
String json="{\"id\":44,\"name\":\"老狼-白衣飘飘的年代\",\"suggest\":{\"input\":\"老狼-白衣飘飘的年代\"}}"; 
String json1="{\"id\":42,\"name\":\"老狼-郎心似铁\",\"suggest\":{\"input\":\"老狼-郎心似铁\"}}"; 
String json2="{\"id\":43,\"name\":\"老狼-流浪歌手的请人\",\"suggest\":{\"input\":\"老狼-流浪歌手的请人\"}}"; 
ESHandler.addOneIndex("chinamedic","pingzhuang", json); 
ESHandler.addOneIndex("chinamedic","pingzhuang", json1); 
ESHandler.addOneIndex("chinamedic","pingzhuang", json2); 
System.out.println(); 
}

3: 然后就是查询获得提示了

/** 
* 搜索建议,自动补全搜索结结果 
* @param indices 索引库名称 
* @param prefix 搜索前缀词 
* @return 建议列表 
*/ 
public static List<String> getCompletionSuggest(String indices, 
String prefix) { 
CompletionSuggestionBuilder suggestionsBuilder = new CompletionSuggestionBuilder( 
"complete"); 
suggestionsBuilder.text(prefix); 
suggestionsBuilder.field("suggest"); 
suggestionsBuilder.size(10); 
SuggestResponse resp = client.prepareSuggest(indices) 
.addSuggestion(suggestionsBuilder).execute().actionGet(); 
List<? extends Entry<? extends Option>> list = resp.getSuggest() 
.getSuggestion("complete").getEntries(); 
List<String> suggests = new ArrayList<String>(); 
if (list == null) { 
return null; 
} else { 
for (Entry<? extends Option> e : list) { 
for (Option option : e) { 
suggests.add(option.getText().toString()); 
} 
} 
return suggests; 
} 
}

ok,到这里一个简单的completion suggester 就完成了。

后续再添加更多高级的使用示例。

经过测试,发现效果不是很好。建议大家使用elasticsearch-suggest-plugin


Elasticsearch 8.x 中,使用 `spring-boot-starter-data-elasticsearch` 实现自动补全功能是可行的,但需要注意与旧版本的兼容性以及字段定义方式的变化。 Spring Boot 对 Elasticsearch 的集成延续了 Spring Data 的设计思想,通过继承对应的 Repository 接口,默认实现了很多常用操作,并可通过注解方式设置索引映射[^2]。对于自动补全功能,Elasticsearch 提供了 `completion` 类型字段用于支持快速前缀匹配和建议查询。 在 Spring Boot 应用中,可以通过实体类字段标注 `@Field(type = FieldType.Completion)` 来定义 completion 字段,并结合自定义 Repository 使用 `suggest` 查询实现自动补全功能[^5]。 ### 示例代码 #### 1. 定义实体类 ```java import org.springframework.data.annotation.Id; import org.springframework.data.elasticsearch.annotations.Document; import org.springframework.data.elasticsearch.annotations.Field; import org.springframework.data.elasticsearch.annotations.FieldType; @Document(indexName = "autocomplete-index") public class SuggestionDocument { @Id private String id; @Field(type = FieldType.Completion) private String[] input; // Getter and Setter } ``` #### 2. 定义 Repository ```java import org.springframework.data.elasticsearch.repository.ElasticsearchRepository; public interface SuggestionRepository extends ElasticsearchRepository<SuggestionDocument, String> { } ``` #### 3. 执行建议查询 Spring Data Elasticsearch 并未直接提供对 `suggest` 查询的支持,因此需要通过 `ElasticsearchRestTemplate` 构建自定义查询: ```java import org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate; import org.springframework.data.elasticsearch.core.query.NativeSearchQuery; import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder; import org.elasticsearch.index.query.QueryBuilders; import org.elasticsearch.search.suggest.SuggestBuilders; import org.elasticsearch.search.suggest.completion.CompletionSuggestionBuilder; public List<String> getSuggestions(String prefix) { CompletionSuggestionBuilder suggestionBuilder = SuggestBuilders.completionSuggestion("input") .prefix(prefix); NativeSearchQuery query = new NativeSearchQueryBuilder() .withQuery(QueryBuilders.matchAllQuery()) .withSuggester(suggestionBuilder) .build(); return elasticsearchRestTemplate.suggest(query, SuggestionDocument.class); } ``` #### 4. 配置文件示例 确保在 `application.yml` 中正确配置 Elasticsearch 连接信息: ```yaml spring: elasticsearch: rest: uris: http://localhost:9200 username: elastic password: your-secure-password ``` ### 注意事项 - Elasticsearch 8.x 在安全性和认证机制上进行了增强,必须启用 HTTPS 和用户认证,因此在配置客户端时需注意添加相应的安全配置。 - Spring Boot 2.x 默认使用的 `spring-boot-starter-data-elasticsearch` 是基于较新版本的 Java High Level REST Client 或新的低延迟客户端,需确认其是否完全兼容 Elasticsearch 8.x 的 API 特性[^4]。 - 如果需要更灵活的控制建议查询逻辑,建议结合 `ElasticsearchRestTemplate` 或封装自定义 Starter 实现更精细的操作[^3]。 ---
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值