GetThreadData API によるセッションデータの取得 - CMS

セッションデータを取得します。

操作説明

セッションデータを取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:GetThreadData

get

*DigitalEmployee

acs:cms:{#regionId}:{#accountId}:digitalemployee/{#name}/thread/{#threadId}

なし

リクエスト構文

GET /digitalEmployee/{name}/thread/{threadId}/data HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
name	string	必須	デジタル従業員の名前。	test
threadId	string	必須	セッション ID。	thread_id01

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
nextToken	string	任意	ページネーショントークン。	xxxxxxxxxx
maxResults	integer	任意	返すセッションデータエントリの最大数。最大値は 100 です。	1

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
maxResults	integer	結果の最大数。	1
data	array<object>	メッセージデータ。
	array<object>	メッセージデータのエントリ。
traceId	string	現在のメッセージリクエストの ID。これは、ルートデータの最初のトレース ID です。	3b5287b717636040171772050d0095
requestId	string	現在のメッセージリクエストの ID。これは、ルートデータの最初のリクエスト ID です。	8FDE2569-626B-5176-9844-28877A*****
messages	array<object>	セッション内のメッセージのリスト。
	array<object>	メッセージの構造。
version	string	メッセージデータのバージョン。	v0.1.0
parentCallId	string	親レベルの実行 ID。	3b5287b7176360
callId	string	実行 ID。	3b5287b7176360
role	string	メッセージを送信したロール。	user
seq	integer	メッセージのシーケンス番号。	0
timestamp	string	ナノ秒単位のタイムスタンプ。	1768702985000000000
type	string	メッセージのタイプ。	task_finished
detail	string	メッセージの詳細。	context of model exceed
contents	array<object>	メッセージコンテンツ。
	object	コンテンツの構造。	{ "append": false, "lastChunk": false, "type": "text", "value": "result output chunk" }
tools	array<object>	使用されたツールのリスト。
	object	ツールの構造。	{ "arguments": { "confidence": "high", "intent": "analyser", "is_new_turn": true, "language": "en", "title": "Root Cause of Alert" }, "id": "IntentRecognition", "name": "IntentRecognition", "status": "start", "toolCallId": "019bc1cb-adad" }
agents	array<object>	呼び出されたエージェントのリスト。
	object	呼び出されたエージェントの詳細。	{ "callId": "019bc1cb-adad", "id": "analyser", "inputs": [ { "append": false, "lastChunk": false, "type": "text", "value": "Analyze this trace: TraceID=xxx" } ], "name": "analyser", "status": "start" }
events	array<object>	イベントのリスト。
	object	イベントの詳細。	{ "payload": { "error": { "code": "TASK_FAILED", "message": "Invalid task parameter", "suggestion": "" }, "statistics": { "duration": 300000 }, "success": false }, "type": "task_finished" }
artifacts	array<object>	生成されたアーティファクトに関する情報。
	object	アーティファクトの構造。	{ "artifactId": "019bc1cb-9600-703axxx", "name": "sql output", "description": "sql generation task result", "extensions": ["sql_generation_tool", "sql_diagnosis"], "metadata": { "model": "qwen3-coder-plus" }, "parts": [ { "text": "select * from table", "kind": "text" } ] }
nextToken	string	ページネーショントークン。	xxxxxxxxx
requestId	string	リクエストの ID。	8FDE2569-626B-5176-9844-28877A*****
threadId	string	セッション ID。	thread_id01
digitalEmployeeName	string	デジタル従業員の名前。	test

例

成功レスポンス

JSONJSON

{
  "maxResults": 1,
  "data": [
    {
      "traceId": "3b5287b717636040171772050d0095",
      "requestId": "8FDE2569-626B-5176-9844-28877A*****",
      "messages": [
        {
          "version": "v0.1.0",
          "parentCallId": "3b5287b7176360",
          "callId": "3b5287b7176360",
          "role": "user",
          "seq": 0,
          "timestamp": "1768702985000000000",
          "type": "task_finished",
          "detail": "context of model exceed",
          "contents": [
            {
              "append": false,
              "lastChunk": false,
              "type": "text",
              "value": "result output chunk"
            }
          ],
          "tools": [
            {
              "arguments": {
                "confidence": "high",
                "intent": "analyser",
                "is_new_turn": true,
                "language": "en",
                "title": "Root Cause of Alert"
              },
              "id": "IntentRecognition",
              "name": "IntentRecognition",
              "status": "start",
              "toolCallId": "019bc1cb-adad"
            }
          ],
          "agents": [
            {
              "callId": "019bc1cb-adad",
              "id": "analyser",
              "inputs": [
                {
                  "append": false,
                  "lastChunk": false,
                  "type": "text",
                  "value": "Analyze this trace: TraceID=xxx"
                }
              ],
              "name": "analyser",
              "status": "start"
            }
          ],
          "events": [
            {
              "payload": {
                "error": {
                  "code": "TASK_FAILED",
                  "message": "Invalid task parameter",
                  "suggestion": ""
                },
                "statistics": {
                  "duration": 300000
                },
                "success": false
              },
              "type": "task_finished"
            }
          ],
          "artifacts": [
            {
              "artifactId": "019bc1cb-9600-703axxx",
              "name": "sql output",
              "description": "sql generation task result",
              "extensions": [
                "sql_generation_tool",
                "sql_diagnosis"
              ],
              "metadata": {
                "model": "qwen3-coder-plus"
              },
              "parts": [
                {
                  "text": "select * from table",
                  "kind": "text"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "nextToken": "xxxxxxxxx",
  "requestId": "8FDE2569-626B-5176-9844-28877A*****",
  "threadId": "thread_id01",
  "digitalEmployeeName": "test"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。