36      財經資訊

搜索操作__JavaSDK手冊_SDK參考手冊_開放搜索-阿裏雲

構造函數

接口描述

CloudsearchSearch類是非線程安全的。建議每次請求完畢後需要調用clear()接口清空上次請求的設置

或者重新實例化一個CloudsearchSearch對象

參數描述

接口定義

CloudsearchSearch(CloudsearchClient client)

執行搜索請求(1)

接口描述

參見:API 配置config子句

參數描述

opts: 此參數如果被賦值，則會把此參數的內容分別賦給相應 的變量。此參數的值 可能有以下內容：

返回結果

• String 返回搜索結果

異常描述

• IOException

• ClientProtocolException

接口定義

String search(Map<String, Object> opts)throws ClientProtocolException, IOException, UnknownHostException

執行搜索請求(2)

返回結果

• String 返回搜索結果

異常描述

• IOException

• ClientProtocolException

接口定義

String search() throws ClientProtocolException, IOException

執行遍曆搜索結果請求(1)

參數描述

opts: 此參數如果被賦值，則會把此參數的內容分別賦給相應 的變量。此參數的值 可能有以下內容：

返回結果

• 搜索結果

異常描述

• IOException

• UnknownHostException

• ClientProtocolException

接口定義

String scroll(Map<String, Object> opts)throws ClientProtocolException, UnknownHostException, IOException

執行遍曆搜索結果請求(2)

返回結果

• 搜索結果

異常描述

• IOException

• UnknownHostException

• ClientProtocolException

接口定義

String scroll() throws ClientProtocolException,UnknownHostException, IOException

添加一個應用列表來進行搜索

參數描述

接口定義

void addIndex(List<String> indexes)

添加一個應用來進行搜索

參數描述

接口定義

void addIndex(String indexName)

在當前搜索中去掉一個應用的搜索結果

參數描述

接口定義

void removeIndex(String indexName)

獲取當前請求中所有的應用名列表

返回結果

• List<String> 返回當前搜索的所有應用列表。

接口定義

List<String> getSearchIndexes()

設置精排表達式名稱(formula)

接口描述

此表達式名稱和結構需要在網站中已經設定，詳情請瀏覽官網中的應用指定的表達式名稱。

參數描述

接口定義

void setFormulaName(String formulaName)

獲取當前設置的表達式名稱(formula)

返回結果

• String 返回當前設定的表達式名稱。

接口定義

String getFormulaName()

設置粗排表達式名稱(first_formula)

接口描述

此表達式名稱和結構需要在網站中已經設定,詳情請瀏覽官網中的應用指定的表達式名稱。

參數描述

接口定義

void setFirstFormulaName(String formulaName)

獲取當前設置的粗排表達式名稱(first_formula)

返回結果

• String 返回當前設定的表達式名稱。

接口定義

String getFirstFormulaName()

添加一條動態摘要(summary)信息(1)

接口描述

增加了此內容後，fieldName字段可能會被截斷、飄紅等。

參數描述

返回結果

• boolean 返回是否添加成功。

接口定義

boolean addSummary(String fieldName, Integer len, String element,String ellipsis, Integer snippet)

添加一條動態摘要(summary)信息(2)

接口描述

增加了此內容後，fieldName字段可能會被截斷、飄紅等。

參數描述

返回結果

• boolean 返回是否添加成功。

接口定義

boolean addSummary(String fieldName)

添加一條動態摘要(summary)信息(3)

接口描述

增加了此內容後，fieldName字段可能會被截斷、飄紅等。

參數描述

返回結果

• boolean 返回是否添加成功。

接口定義

boolean addSummary(String fieldName, Integer len, String ellipsis,Integer snippet, String elementPrefix, String elementPostfix)

獲取當前所有設定的摘要信息(summary)

返回結果

• Map 返回summary信息

接口定義

Map<String, Map<String, Object>> getSummary()

獲取指定字段的摘要信息(summary)

參數描述

返回結果

• Map<String,Object> 返回指定字段的summary信息。

接口定義

Map<String, Object> getSummary(String fieldName)

把摘要信息生成字符串並返回(summary)

返回結果

• String 返回字符串的summary信息。

接口定義

String getSummaryString()

設置返回的數據格式名稱(format)

參數描述

接口定義

void setFormat(String format)

獲取當前的數據格式名稱(format)

返回結果

• String 返回當前的數據格式名稱。

接口定義

String getFormat()

設置返回結果的偏移量(start)

參數描述

接口定義

void setStartHit(int start)

獲取返回結果的偏移量(start)

返回結果

• int 返回當前設定的偏移量。

接口定義

int getStartHit()

設置當前返回結果集的文檔個數(hit)

參數描述

接口定義

void setHits(int hits)

獲取當前設定的結果集的文檔條數(hit)

返回結果

• int 返回當前指定的doc個數。

接口定義

int getHits()

增加一個排序字段及排序方式(sort)

接口描述

詳細描述請見API 排序sort子句

參數描述

接口定義

void addSort(String field, String sortChar)

增加一個排序字段(sort)

接口描述

詳細描述請見API 排序sort子句

參數描述

接口定義

void addSort(String field)

刪除指定字段的排序(sort)

參數描述

接口定義

void removeSort(String field)

獲取排序信息(sort)

返回結果

• 返回當前所有的排序字段及升降序方式。

接口定義

Map<String, String> getSort()

獲取字符串類型的排序信息(sort)

接口描述

把排序信息生成字符串並返回。

返回結果

• String 返回字符串類型的排序規則。

接口定義

String getSortString()

增加一個自定義參數

參數描述

接口定義

void addCustomParam(String paramKey, String paramValue)

獲取自定義參數

返回結果

• 返回自定義參數

接口定義

Map<String, String> getCustomParam()

增加過濾規則(filter)(1)

接口描述

詳細請見 API 過濾filter子句

參數描述

接口定義

void addFilter(String filter, String operator)

增加過濾規則(filter)(2)

接口描述

詳細請見 API 過濾filter子句

參數描述

接口定義

void addFilter(String filter)

獲取過濾規則(filter)

返回結果

• String 返回字符串類型的過濾規則。

接口定義

String getFilter()

添加統計信息(aggregate)相關參數(1)

接口描述

一個關鍵詞通常能命中數以萬計的文檔，用戶不太可能瀏覽所有文檔來獲取信息。而用戶感興趣的

可 能是一些統計類的信息，比如，查詢“手機”這個關鍵詞，想知道每個賣家所有商品中的最高價格。

則可以按照賣家的user_id分組，統計每個小組中最大的price值，例如：

groupKey:user_id,aggFun:max(price)

詳細說明請參見：APi aggregate子句說明

參數描述

返回結果

• boolean 返回添加成功或失敗。

接口定義

boolean addAggregate(String groupKey, String aggFun, String range,String maxGroup, String aggFilter, String aggSamplerThresHold,String aggSamplerStep)

添加統計信息(aggregate)相關參數(2)

參數描述

返回結果

• boolean 返回添加成功或失敗。

接口定義

boolean addAggregate(String groupKey, String aggFun)

獲取用戶設定的統計相關信息(aggregate)

返回結果

• 返回用戶設定的統計信息。

接口定義

List<Map<String, Object>> getAggregate()

返回字符串類型的統計信息(aggregate)

返回結果

• 返回字符串類型的統計信息。

接口定義

String getAggregateString()

添加聚合打散條件(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

排序，各個用戶的 商品都得到了展示機會，結果排序更趨於合理。

詳細說明請見：API distinct子句

參數描述

返回結果

• 返回是否添加成功。

接口定義

boolean addDistinct(String key, int distCount, int distTimes,String reserved, String distFilter, String updateTotalHit,double grade)

添加聚合打散條件(distinct)(2)

參數描述

返回結果

• 返回是否添加成功。

接口定義

boolean addDistinct(String key)

添加聚合打散條件(distinct)(3)

參數描述

返回結果

• 返回是否添加成功。

接口定義

boolean addDistinct(String key, int distCount)

添加聚合打散條件(distinct)(4)

參數描述

返回結果

• 返回是否添加成功。

接口定義

boolean addDistinct(String key, int distCount, int distTimes)

添加聚合打散條件(distinct)(5)

參數描述

返回結果

• 返回是否添加成功。

接口定義

boolean addDistinct(String key, int distCount, int distTimes,String reserved)

添加聚合打散條件(distinct)(6)

參數描述

返回結果

• 返回是否添加成功。

接口定義

boolean addDistinct(String key, int distCount, int distTimes,String reserved, String distFilter)

添加聚合打散條件(distinct)(7)

參數描述

返回結果

• 返回是否添加成功。

接口定義

boolean addDistinct(String key, int distCount, int distTimes,String reserved, String distFilter, String updateTotalHit)

刪除某個字段的所有distinct信息

參數描述

接口定義

void removeDistinct(String distinctKey)

獲取所有的distinct信息

返回結果

• 返回所有的distinct信息。

接口定義

Map<String, Map<String, Object>> getDistinct()

獲取string類型的所有的distinct信息

返回結果

• 返回字符串類型的distinct信息。

接口定義

String getDistinctString()

設定指定索引字段範圍的搜索關鍵詞(query)

接口描述

此query是查詢必需的一部分，可以指定不同的索引名，並同時可指定多個查詢及之間的關係

（AND, OR, ANDNOT, RANK）。

例如查詢subject索引字段的query:“手機”，可以設置為 query=subject:’手機’。

上邊例子如果查詢price 在1000-2000之間的手機，其查詢語句為： query=subject:’手機’

AND price:[1000,2000]

NOTE: text類型索引在建立時做了分詞，而string類型的索引則沒有分詞。

詳細說明請見：API query子句

參數描述

接口定義

void setQueryString(String query)

獲取當前指定的查詢詞內容(query)

返回結果

• 返回當前設定的查詢query子句內容。

接口定義

String getQuery()

設定當前的kvpair

接口描述

詳細請見API 自定義kvpair子句

參數描述

接口定義

void setPair(String pair)

獲取當前的kvpair

返回結果

• String 返回當前設定的kvpair。

接口定義

String getPair()

設定rerank_size

參數描述

接口定義

void setRerankSize(int rerank_size)

獲取當前rerank_size

接口描述

rerankSize表示參與精排算分的文檔個數，一般不用修改，使用默認值就能滿足，不用設置,會自動使用默認值200

返回結果

• int 當前設定的rerank_size

接口定義

int getRerankSize()

設置搜索返回的索引字段列表(fetch_fields)

參數描述

接口定義

void addFetchFields(List<String> fields)

添加某個字段到搜索結果字段列表中(fetch_fields)

參數描述

接口定義

void addFetchField(String field)

獲取搜索結果包含的字段列表(fetch_fields)

返回結果

• 返回指定返回字段的列表。

接口定義

List<String> getFetchFields()

添加一條查詢分析規則(qp)

參數描述

接口定義

void addQpName(String qpName)

添加一條查詢分析規則(qp)

參數描述

接口定義

void addQpNames(List<String> qpNames)

獲取當前設置的查詢分析規則(qp)

返回結果

• 返回當前設置的所有查詢分析規則名稱

接口定義

List<String> getQpNames()

關閉某些功能模塊(disable)

接口描述

有如下場景需要考慮：

1、如果要關閉整個qp的功能，則指定functionName="qp"；

2、如果待關閉的功能模塊有更詳細的配置可以通過value指定，如果沒有可以為"";

如果需要關閉查詢分析功能，可以使用下麵的disableQp方法，可以更方便的指定需要禁用的功能子項

參數描述

接口定義

void addDisableFunction(String functionName, String value)

獲取當前設置的所有禁用函數(disable)

返回結果

• 返回當前設置的所有需要禁用的函數

接口定義

String getDisableFunctions()

關閉查詢分析模塊(qp)

接口描述

qp有如下模塊：

1、spell_check: 檢查用戶查詢串中的拚寫錯誤，並給出糾錯建議。

2、term_weighting: 分析查詢中每個詞的重要程度，並將其量化成權重，權重較低的詞可能不會參與召回。

3、stop_word: 根據係統內置的停用詞典過濾查詢中無意義的詞

4、synonym: 根據係統提供的通用同義詞庫和語義模型，對查詢串進行同義詞擴展，以便擴大召回。

example:

標示關閉整個qp

"qp:spell_check" 標示關閉qp的拚音糾錯功能。

"qp:stop_word:index_name1|index_name2" 標示關閉qp中index_name1和index_name2上的停用詞功能。

"qp:stop_word:index_name1|index_name2,synonym:index_name3" 標示關閉qp中index_name1和index_name2上的停用詞功能,關閉index_name3上的同義詞功能

參數描述

接口定義

void disableQp(Map<String, ArrayList<String>> opts)

關閉整個查詢分析模塊(qp)

接口定義

void disableQp()

設置scroll請求的有效期

參數描述

接口定義

void setScrollExpire(String expire)

設置scroll請求的有效期

參數描述

接口定義

void setScrollExpire(int expire)

獲取設置的scroll請求有效期

返回結果

• String 設置的scroll請求有效期

接口定義

String getScrollExpire()

設置搜索請求類型(search_type)

參數描述

接口定義

void setSearchType(String searchType)

獲取設置的搜索請求類型(search_type)

返回結果

• String 設置的搜索請求類型

接口定義

String getSearchType()

設置scroll請求的起始id

參數描述

接口定義

void setScrollId(String scrollId)

獲取設置的scroll請求起始id

返回結果

• 設置的scroll請求起始id

接口定義

String getScrollId()

清空用戶設置的所有搜索條件

接口定義

void clear()

添加一條自定義配置

參數描述

接口定義

void addCustomConfig(String key, Object value)

移除自定義配置

參數描述

接口定義

void removeCustomConfig(String key)

獲取上次搜索請求的信息

返回結果

• String 上次搜索請求的信息

接口定義

String getDebugInfo()

搜索示例

import com.opensearch.javasdk.*;
String accesskey= "您的阿裏雲的Access Key ID";
String secret = "阿裏雲 Access Key ID 對應的 Access Key Secret";
Map<String, Object> opts = new HashMap<String, Object>();
// 這裏的host需要根據訪問應用基本詳情中的API入口來確定
CloudsearchClient client = new CloudsearchClient(accesskey, secret ,host, opts，
                                          KeyTypeEnum.ALIYUN);
CloudsearchSearch search = new CloudsearchSearch(client);
// 添加指定搜索的應用：
search.addIndex("my_demo");
// 指定搜索的關鍵詞，如果沒有輸入索引名稱，則使用“default”
search.setQueryString("'詞典'");
//和下邊等同
search.setQueryString("default:'詞典'");
// 或者指定某索引字段進行查找。
// 索引字段名稱是您在您的數據結構中的“索引到”字段。
search.setQueryString("index_name:'詞典'");
// 指定搜索返回的格式。
search.setFormat("json");
// 設定過濾條件。字段必須設定為可過濾
search.addFilter("price>10");
// 設定排序方式。字段必須設定為可過濾
search.addSort("price", "+");
// 返回搜索結果。
System.out.println(search.search());