什麼是下拉提示功能,如何使用 - OpenSearch

下拉提示是搜尋服務的基礎功能，在使用者輸入查詢詞的過程中，智能推薦候選query，減少使用者輸入，協助使用者儘快找到想要的內容。OpenSearch下拉提示在實現了中文首碼，拼音全拼，拼音首字母簡拼查詢等通用功能的基礎上，實現了基於使用者文檔內容的query智能識別。使用者通過控制台的簡單配置，就能擁有專屬的定製下拉提示。此外，控制台上還提供了黑名單，推薦詞條功能，讓使用者進一步控制下拉提示的結果，實現更靈活的定製。更多關於下拉提示產品使用介紹，詳見產品使用文檔。

URL

/v3/openapi/apps/{appName}/suggest/{suggestName}/search

{appName} 為您的應用程式名稱
{suggestName} 為您的下拉提示模型名稱
以上 URL 省略了請求Header參數及編碼等因素
以上 URL 中省略了訪問應用的 host 地址

支援格式

JSON

HTTP請求方式

GET

查詢參數

參數	類型	必須	取值範圍	預設值	描述
query	String	是			搜尋關鍵詞（包含中文需進行urlencode編碼）
hit	int	否	[1-10]	10	下拉提示條數
user_id	String	否			用來標識發起當前下拉提示請求的終端使用者, user_id的值需要做urlencode。建議跟app搜尋請求中user_id參數保持一致，詳見搜尋處理。
re_search	String	否			預設開啟同音別字補全召回可以設定re_search="disable"關閉該功能

註：下拉提示的query參數和search介面的query參數不同。下拉提示的query參數就是使用者在輸入框中輸入的原始文本，不需要索引欄位名，直接query=mp3（mp3為使用者輸入查詢詞）即可。

返回結果

參數	類型	描述
request_id	string	該條查詢的記錄id，主要用於排查問題使用
searchtime	float	引擎查詢耗時，單位為秒
suggestions	array	下拉提示結果，array的每個值代表一個結果
errors	array	錯誤內容，message代表錯誤資訊。code 錯誤碼含義參考錯誤碼文檔

樣本

請求：（此處省略了請求Header參數及編碼等因素）

http://$host/v3/openapi/apps/app_demo/suggest/suggest_demo/search?hit=10&query=連衣&user_id=xxx

成功返回：

{
    "request_id": "150116615820104116121674",
    "searchtime": 0.002654,
    "suggestions": [
        {
            "suggestion": "連衣裙"
        },
        {
            "suggestion": "連衣裙春裝"
        },
        {
            "suggestion": "連衣裙文藝"
        }
    ]
}

錯誤返回：

{
    "request_id": "150116635320104116122572",
    "searchtime": 0.037484,
    "suggestions": [],
    "errors": [
        {
            "code": 2551,
            "message": "suggester not found"
        }
    ]
}