com.aliyun.opensearch.search

Class SearchParamsBuilder

java.lang.Object

com.aliyun.opensearch.search.SearchParamsBuilder

public class SearchParamsBuilder
extends java.lang.Object

Convenience util to build some complex search params.

Author:

Ken

Method Summary

Modifier and Type	Method and Description
SearchParamsBuilder	addCustomParam(java.lang.String key, java.lang.String value) Adds the custom param.
SearchParamsBuilder	addDisableFunction(java.lang.String functionName, java.lang.String value) 关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“|”分隔，可以为index_name1|index_name2...
SearchParamsBuilder	addDistinct(java.lang.String key, int distCount, int distTimes, boolean reserved, java.lang.String distFilter, boolean updateTotalHit, double grade) 添加聚合打散条件(distinct)(1) 例如：检索关键词“手机”共获得10个结果，分别为：doc1，doc2，doc3，doc4，doc5，doc6， doc7，doc8，doc9，doc10。其中前三个属于用户A，doc4-doc6属于用户B，剩余四个属于 用户C。如果前端每页仅展示5个商品，则用户C将没有展示的机会。但是如果按照user_id进行抽 取，每轮抽取1个，抽取2次，并保留抽取剩余的结果，则可以获得以下文档排列顺序：doc1、 doc4、doc7、doc2、doc5、doc8、doc3、doc6、doc9、doc10。可以看出，通过distinct 排序，各个用户的 商品都得到了展示机会，结果排序更趋于合理。
SearchParamsBuilder	addFilter(java.lang.String filter) 增加过滤规则(filter)(2).
SearchParamsBuilder	addFilter(java.lang.String filter, java.lang.String operator) 增加过滤规则(filter)(1).
SearchParamsBuilder	addSummary(java.lang.String fieldName, java.lang.Integer len, java.lang.String element, java.lang.String ellipsis, java.lang.Integer snippet) 添加一条动态摘要(summary)信息(1) 增加了此内容后，fieldName字段可能会被截断、飘红等。.
com.aliyun.opensearch.sdk.generated.search.SearchParams	build() Builds the final SearchParams.
static SearchParamsBuilder	create(com.aliyun.opensearch.sdk.generated.search.Config config) Creates a new SearchParamsBuilder onject.
static SearchParamsBuilder	create(com.aliyun.opensearch.sdk.generated.search.SearchParams otherSearchParams) Creates a new SearchParamsBuilder onject with other SearchParams.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static SearchParamsBuilder create(com.aliyun.opensearch.sdk.generated.search.Config config)

Creates a new SearchParamsBuilder onject.

Parameters:

config - the config

Returns:

the search params builder

create

public static SearchParamsBuilder create(com.aliyun.opensearch.sdk.generated.search.SearchParams otherSearchParams)

Creates a new SearchParamsBuilder onject with other SearchParams.

Parameters:

otherSearchParams - the other search params

Returns:

the search params builder

addCustomParam

public SearchParamsBuilder addCustomParam(java.lang.String key,
                                          java.lang.String value)

Adds the custom param.

Both key and value are not accept null value.

Parameters:

key - the key

value - the value

addFilter

public SearchParamsBuilder addFilter(java.lang.String filter,
                                     java.lang.String operator)

增加过滤规则(filter)(1).

Parameters:

filter - 过滤规则，例如fieldName <= 1。

operator - 操作符，可以为 AND OR。默认为“AND”

addFilter

public SearchParamsBuilder addFilter(java.lang.String filter)

增加过滤规则(filter)(2).

Parameters:

filter - 过滤规则。

addSummary

public SearchParamsBuilder addSummary(java.lang.String fieldName,
                                      java.lang.Integer len,
                                      java.lang.String element,
                                      java.lang.String ellipsis,
                                      java.lang.Integer snippet)

添加一条动态摘要(summary)信息(1) 增加了此内容后，fieldName字段可能会被截断、飘红等。.

Parameters:

fieldName - 指定的生效的字段。此字段必需为可分词的text类型的字段。

len - 指定结果集返回的词字段的字节长度，一个汉字为2个字节。

element - 指定命中的query的标红标签，可以为em等。

ellipsis - 指定用什么符号来标注未展示完的数据，例如“...”。

snippet - 指定query命中几段summary内容。

addDisableFunction

public SearchParamsBuilder addDisableFunction(java.lang.String functionName,
                                              java.lang.String value)

关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“|”分隔，可以为index_name1|index_name2... 3、如果要关闭多个function可以用“,”分隔，例如：disableValue="qp:function_name1:index_name1,qp:function_name2:index_name1" qp有如下模块： 1、spell_check: 检查用户查询串中的拼写错误，并给出纠错建议。 2、term_weighting: 分析查询中每个词的重要程度，并将其量化成权重，权重较低的词可能不会参与召回。 3、stop_word: 根据系统内置的停用词典过滤查询中无意义的词 4、synonym: 根据系统提供的通用同义词库和语义模型，对查询串进行同义词扩展，以便扩大召回。 example: "qp" 标示关闭整个qp "qp:spell_check" 标示关闭qp的拼音纠错功能。 "qp:stop_word:index_name1|index_name2" 标示关闭qp中index_name1和index_name2上的停用词功能。

Parameters:

functionName - 需要禁用的函数名称

value - 待禁用函数的详细说明

addDistinct

public SearchParamsBuilder addDistinct(java.lang.String key,
                                       int distCount,
                                       int distTimes,
                                       boolean reserved,
                                       java.lang.String distFilter,
                                       boolean updateTotalHit,
                                       double grade)

添加聚合打散条件(distinct)(1) 例如：检索关键词“手机”共获得10个结果，分别为：doc1，doc2，doc3，doc4，doc5，doc6， doc7，doc8，doc9，doc10。其中前三个属于用户A，doc4-doc6属于用户B，剩余四个属于 用户C。如果前端每页仅展示5个商品，则用户C将没有展示的机会。但是如果按照user_id进行抽 取，每轮抽取1个，抽取2次，并保留抽取剩余的结果，则可以获得以下文档排列顺序：doc1、 doc4、doc7、doc2、doc5、doc8、doc3、doc6、doc9、doc10。可以看出，通过distinct 排序，各个用户的 商品都得到了展示机会，结果排序更趋于合理。

Parameters:

key - 为用户用于做distinct抽取的字段，该字段要求为可过滤字段。

distCount - 为一次抽取的document数量，默认值为1。

distTimes - 为抽取的次数，默认值为1。

reserved - 为是否保留抽取之后剩余的结果，true为保留，false则丢弃，丢弃时totalHits的个数会减去被distinct而丢弃的个数，但这个结果不一定准确，默认为true。

distFilter - 为过滤条件，被过滤的doc不参与distinct，只在后面的 排序中，这些被过滤的doc将和被distinct出来的第一组doc一起参与排序。默认是全部参与distinct。

updateTotalHit - 当reserved为false时，设置update_total_hit为true，则最终total_hit会减去被distinct丢弃的的数目（不一定准确），为false则不减； 默认为false。

grade - 指定档位划分阈值。

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

build

public com.aliyun.opensearch.sdk.generated.search.SearchParams build()

Builds the final SearchParams.

Returns:

the search params