功能簡介
SearchParams的工具類,提供了更為便捷的操作
構造函數(1)
該類是直接通過調用該類中靜態方法傳參并返回生成對象
SearchParamsBuilder SearchParamsBuilder.create(SearchParams otherSearchParams)
參數描述
參數名稱 | 類型 | 描述 |
otherSearchParams | SearchParams | 根據SearchParams參數對象創建SearchParamsBuilder實例對象. |
構造函數(2)
該類是直接通過調用該類中靜態方法傳參并返回生成對象
SearchParamsBuilder SearchParamsBuilder.create(Config config)
參數描述
參數名稱 | 類型 | 描述 |
config | Config | 根據config參數對象創建SearchParamsBuilder對象. |
增加過濾規則(1)
接口定義
增加過濾規則(1)
SearchParamsBuilder addFilter(String filter)
參數描述
參數名稱 | 類型 | 描述 |
filter | String | 過濾規則,例如fieldName >= 1. |
增加過濾規則(2)
接口定義
增加過濾規則(2)
SearchParamsBuilder addFilter(String filter,String operator)
參數描述
參數名稱 | 類型 | 描述 |
filter | String | 過濾規則,例如fieldName >= 1. |
operator | String | 操作符,可以為 AND OR。默認為 AND. |
添加自定義參數(鍵值對)
接口定義
添加自定義參數(鍵值對)
SearchParamsBuilder addCustomParam(String key,String value)
參數描述
參數名稱 | 類型 | 描述 |
key | String | 參數鍵名 |
value | String | 參數鍵值 |
禁用某個功能
接口定義
禁用某個功能
SearchParamsBuilder addDisableFunction(String function,String value)
參數描述
參數名稱 | 類型 | 描述 |
function | String | 功能名稱 |
value | String | 參數值 |
添加打散條件
接口定義
添加打散條件
SearchParamsBuilder addDistinct(String key,int distCount,int distTimes,boolean reserved,String distFilter,boolean updateTotalHit,double grade)
參數描述
參數名稱 | 類型 | 描述 |
key | String | 為用戶用于做distinct抽取的字段,該字段要求為屬性字段 |
distCount | int | 為一次抽取的document數量,默認值為1 |
distTimes | int | 為抽取的次數,默認值為1 |
reserved | boolean | 為是否保留抽取之后剩余的結果,true為保留,false則丟棄,丟棄時totalHits的個數會減去被distinct而丟棄的個數,但這個結果不一定準確,默認為true |
distFilter | String | 為過濾條件,被過濾的doc不參與distinct,只在后面的排序中,這些被過濾的doc將和被distinct出來的第一組doc一起參與排序。默認是全部參與distinct |
updateTotalHit | boolean | 當reserved為false時,設置update_total_hit為true,則最終total_hit會減去被distinct丟棄的數目(不一定準確),為false則不減; 默認為false |
grade | double | 指定檔位劃分閾值 |
添加一條動態摘要(summary)信息
接口定義
添加一條動態摘要(summary)信息
SearchParamsBuilder addSummary(String fieldName, Integer len, String element, String ellipsis, Integer snippet)
參數描述
參數名稱 | 類型 | 描述 |
fieldName | String | 指定的生效的字段,此字段必需為可分詞的text類型的字段. |
len | Integer | 指定結果集返回的詞字段的字節長度,一個漢字為2個字節. |
element | String | 指定命中的query的標紅標簽,可以為em等. |
ellipsis | String | 指定用什么符號來標注未展示完的數據,例如“…”. |
snippet | Integer | 指定query命中幾段summary內容. |
添加一條動態摘要(summary)信息,增加了此內容后,fieldName字段可能會被截斷、飄紅等。