このトピックでは、OpenSearch LLM ベースの対話型検索エディションで履歴セッションリストを取得するための API について説明します。
前提条件
ID 認証用の API キーを取得します。OpenSearch LLM ベースの対話型検索サービスを呼び出すときは、呼び出し元の ID を認証する必要があります。詳細については、「API キーを管理する」をご参照ください。
サービスエンドポイントを取得します。OpenSearch LLM ベースの対話型検索サービスを呼び出すときは、サービスエンドポイントを提供する必要があります。詳細については、「エンドポイントを取得する」をご参照ください。
注意事項
履歴セッションデータは、Alibaba Cloud アカウント、RAM ユーザー、および API キーのディメンション全体で完全に分離されています。セッションデータは、異なる ID エンティティと認証方式間で共有されません。
API 情報
リクエストメソッド | リクエストプロトコル | リクエストデータ形式 |
GET | HTTP | JSON |
リクエスト URL
{host}/v3/openapi/apps/{app_group_identity}/chat-history?page_number=1&page_size=10{host}: サービスの呼び出しに使用するエンドポイント。インターネットまたは VPC 経由で API サービスを呼び出すことができます。詳細については、「エンドポイントを取得する」をご参照ください。{app_group_identity}: アプリケーション名。 OpenSearch LLM ベースの対話型検索 コンソール にログインし、インスタンス管理で対応するインスタンスのアプリケーション名を確認する必要があります。
リクエストパラメーター
ヘッダーパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
Content-Type | 文字列 | はい | リクエストのデータ形式。 JSON 形式のみがサポートされています。値を application/json に設定します。 | application/json |
Authorization | 文字列 | はい | リクエスト認証に使用する API キー。値は Bearer で始まる必要があります。 | Bearer OS-d1**2a |
ボディパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
page_number | 整数 | いいえ | 最初のページ番号。 | 1 |
page_size | 整数 | いいえ | 1 ページあたりのエントリ数。(デフォルト: 10、最大: 20) | 10 |
リクエストボディの例
curl -X GET "{host}/v3/openapi/apps/{app_group_identity}/chat-history?page_number=1&page_size=10" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {API Key}"レスポンスパラメーター
パラメーター | タイプ | 説明 |
request_id | 文字列 | リクエスト ID。 |
result | マップ | 返されたデータ。 |
result.latency | 浮動小数点数 | リクエストが成功したときに API で消費された時間 (ミリ秒)。 |
result.total_count | 整数 | データエントリの総数。 |
result.data | リスト | レスポンスデータ。 |
result.data[0].title | 文字列 | セッションタイトル。 |
result.data[0].chat_id | 文字列 | セッション ID。 |
result.data[0].status | 文字列 | セッションまたはタスクのステータス。 |
result.data[0].time | 文字列 | セッションが開始された時刻。 |
code | 文字列 | 返されたエラーコード (エラーが発生しなかった場合は返されません)。 |
message | 文字列 | 返されたエラーメッセージ (エラーが発生しなかった場合は返されません)。 |
レスポンスボディの例
{
"request_id": "a842*******************133b",
"status": "OK",
"total_count": 1,
"latency": 0,
"result": [
{
"chat_id": "1751622286901",
"title": "Recommend a Jay Chou album for me",
"time": "2025-07-04 21:38:06",
"status": "SUCCESS"
}
],
"errors": []
}