調用API擷取熱搜列表與底紋列表-智能OpenSearch OpenSearch-阿里雲

本文介紹熱搜與底紋的API詳情。

查詢熱搜列表

查詢熱搜列表，預設返回模型推薦的熱搜列表。

要求方法

GET

URL

/v3/openapi/apps/{app_name}/actions/hot?hit={hit}&sort_type={sort_type}&user_id={user_id}&model_name={model_name}

說明

以上 URL 省略了請求Header參數及編碼等因素。

以上 URL 中省略了訪問應用的 host 地址。

請求參數

名稱	是否必須	類型	預設值	說明	備忘
app_name	是	string		OpenSearch的應用程式名稱
hit	否	int	10	查詢的資料條數	hit範圍：(0,30]
sort_type	否	string	default	default：預設熱搜結果，pv：查詢pv最高的熱搜，uv：查詢uv最高的熱搜（敬請期待）
model_name	否	string		模型名稱

返回參數

參數	是否必須	類型	說明
request_id	是	string	請求ID
result	是	array	查詢所得的熱搜列表

請求樣本

http://$host/v3/openapi/apps/{app_name}/actions/hot?hit={hit}&sort_type={sort_type}&model_name={model_name}

返回樣本

正確返回

{
   "request_id": "150116615820104116121674",
   "searchtime": 0.002654,
   "result": [
       {
           "hot": "連衣裙", //熱搜詞
           "pv": 100000,    //訓練來源時段內統計的請求流量次數（普通模型預設統計14天內）
         	 "tags":0         //即時熱搜模型返回的標籤：新-0，熱-1，爆-2
       },
       {
           "hot": "連衣裙春裝",
           "pv": 50000
       },
       {
           "hot": "連衣裙文藝",
           "pv": 10000
       }
   ]
}

錯誤返回參考：錯誤碼說明

查詢底紋列表

查詢底紋列表，預設返回模型推薦的底紋列表

要求方法

GET

URL

/v3/openapi/apps/{app_name}/actions/hint?hit={hit}&sort_type={sort_type}&user_id={user_id}&model_name={model_name}

說明

以上 URL 省略了請求Header參數及編碼等因素。
以上 URL 中省略了訪問應用的 host 地址。

請求參數

名稱	是否必須	類型	預設值	說明	備忘
app_name	是	string		OpenSearch的應用程式名稱
hit	否	int	3	查詢的資料條數	hit範圍：(0,10] 個人化底紋：hit範圍：(0,30]
sort_type	否	string	default	default：預設底紋結果 pv：查詢pv最高的底紋
user_id	否	string		使用者id，查詢個人化底紋結果時需要	未傳或不存在則降級為普通效果
model_name	否	string		模型名稱	未傳則使用預設模型

返回參數

名稱	類型	說明
data	object	操作結果

參數說明：

參數	是否必須	類型	說明
list	是	array	查詢所得的底紋列表

請求樣本

http://{host}/v3/openapi/apps/{app_name}/actions/hint?hit={hit}&sort_type={sort_type}&user_id={user_id}&model_name={model_name}

返回樣本

正確返回

{
   "request_id": "150116615820104116121674",
   "searchtime": 0.002654,
   "result": [
       {
           "hint": "連衣裙",
           "pv": 100000
       },
       {
           "hint": "連衣裙春裝",
           "pv": 50000
       },
       {
           "hint": "連衣裙文藝",
           "pv": 10000
       }
   ]
}

錯誤返回參考：錯誤碼說明