モデルのおすすめ結果 - 検索履歴とヒントのクエリ - OpenSearch

このトピックでは、検索履歴とヒントをクエリするための API 操作の使用方法について説明します。

検索履歴のリストのクエリ

検索履歴のリストをクエリします。デフォルトでは、返される結果はモデルによって推奨される検索履歴のリストです。

サポートされている HTTP リクエストメソッド

GET

URL

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

説明

サンプル URL には、リクエストヘッダーやエンコーディングメソッドなどの情報は含まれていません。

サンプル URL には、OpenSearch アプリケーションへの接続に使用するエンドポイントも含まれていません。

リクエストパラメーター

パラメーター	必須	タイプ	デフォルト値	説明	備考
app_name	はい	文字列		OpenSearch アプリケーションの名前。
hit	いいえ	int	10	クエリする検索履歴の数。	有効な値: (0,30]。
sort_type	いいえ	文字列	default	クエリされた検索履歴のソート方法。このパラメーターが default に設定されている場合、検索履歴はソートされません。このパラメーターが pv に設定されている場合、検索履歴はページビュー (PV) 数に基づいて降順にソートされます。このパラメーターが uv に設定されている場合、検索履歴は検索履歴をクリックしたユニークビジター (UV) の数に基づいて降順にソートされます。 uv オプションは近日中にサポートされる予定です。
model_name	いいえ	文字列		結果が返されるモデルの名前。

レスポンスパラメーター

パラメーター	必須	デフォルト値	タイプ	説明
request_id	はい		文字列	リクエスト ID。
result	はい		配列	クエリされた検索履歴。

サンプルリクエスト

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
       }
   ]
}

エラーレスポンスの例
詳細については、「エラーコード」をご参照ください。

ヒントのリストのクエリ

ヒントのリストをクエリします。デフォルトでは、返される結果は、モデルによって推奨されるヒントのリストです。