LogTree の照会

このAPIを使用して、メッセージIDに基づいて対応するLogTreeトレースデータを照会できます。

リクエストメソッド

GET

エンドポイント

https://api-${endpoint}.gptbots.ai/v1/bot/logtree/query

認証

認証方法については API 概要をご参照ください。

リクエスト

リクエスト例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/logtree/query?msgid=6a475fa11d276b3d062a1be8' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/logtree/query?msgid=6a475fa11d276b3d062a1be8' \
-H 'Authorization: Bearer ${API Key}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${API Key}	認証には `Authorization: Bearer ${API Key}` を使用してください。トークンはAPIキーページから取得できます。

リクエストパラメータ

フィールド名	タイプ	必須	説明
msgid	String	必須	メッセージIDです。通常は会話APIが返す message_id を指定します。

レスポンス

レスポンス例

{ "treeData": [ { "children": null, "actionId": "START_001", "traceId": "lyyqYMnfFSW5vWF5qdj5lR0t0DpjQR3icJi1lxm2CvUWpW8oI1-1783062433496", "msgId": "6a475fa11d276b3d062a1be8", "botId": "664ed07a277ef442b132feba", "logComponentId": "1lwSWOnjxuQK", "logComponentName": "Start", "logComponentTitle": null, "logComponentType": "Start", "isComponent": true, "actionType": "Start", "actionName": "Start", "startTimestampMillis": 1783062433496, "endTimestampMillis": 1783062433654, "runningStatus": "SUCCESS", "latencyMillis": 0, "input": { "content": [ { "type": "Text", "text": "1+1=?" } ] }, "output": { "content": [ { "type": "Text", "text": "1+1=?" } ] }, "inputTokens": 0, "outputTokens": 0, "totalTokens": "0", "extension": "{}", "createTime": 1783062433679, "uuid": "e53dcbb9-07d1-4019-9b66-e9d32b28bcbf", "workflowExecutionId": "", "parentId": "1lwSWOnjxuQK" } ], "summary": { "runningStatus": "SUCCESS", "botId": "664ed07a277ef442b132feba", "startTimestampMillis": 1783062433498, "endTimestampMillis": 1783062434933, "totalLatencyMillis": 1437, "totalTokens": 34, "stepCount": 3, "credit": -0.0031 }, "msgId": "6a475fa11d276b3d062a1be8", "conversationId": "6a475fa11d276b3d062a1be5", "traceId": "lyyqYMnfFSW5vWF5qdj5lR0t0DpjQR3icJi1lxm2CvUWpW8oI1-1783062433496" }

                      
                      {
  "treeData": [
    {
      "children": null,
      "actionId": "START_001",
      "traceId": "lyyqYMnfFSW5vWF5qdj5lR0t0DpjQR3icJi1lxm2CvUWpW8oI1-1783062433496",
      "msgId": "6a475fa11d276b3d062a1be8",
      "botId": "664ed07a277ef442b132feba",
      "logComponentId": "1lwSWOnjxuQK",
      "logComponentName": "Start",
      "logComponentTitle": null,
      "logComponentType": "Start",
      "isComponent": true,
      "actionType": "Start",
      "actionName": "Start",
      "startTimestampMillis": 1783062433496,
      "endTimestampMillis": 1783062433654,
      "runningStatus": "SUCCESS",
      "latencyMillis": 0,
      "input": {
        "content": [
          {
            "type": "Text",
            "text": "1+1=?"
          }
        ]
      },
      "output": {
        "content": [
          {
            "type": "Text",
            "text": "1+1=?"
          }
        ]
      },
      "inputTokens": 0,
      "outputTokens": 0,
      "totalTokens": "0",
      "extension": "{}",
      "createTime": 1783062433679,
      "uuid": "e53dcbb9-07d1-4019-9b66-e9d32b28bcbf",
      "workflowExecutionId": "",
      "parentId": "1lwSWOnjxuQK"
    }
  ],
  "summary": {
    "runningStatus": "SUCCESS",
    "botId": "664ed07a277ef442b132feba",
    "startTimestampMillis": 1783062433498,
    "endTimestampMillis": 1783062434933,
    "totalLatencyMillis": 1437,
    "totalTokens": 34,
    "stepCount": 3,
    "credit": -0.0031
  },
  "msgId": "6a475fa11d276b3d062a1be8",
  "conversationId": "6a475fa11d276b3d062a1be5",
  "traceId": "lyyqYMnfFSW5vWF5qdj5lR0t0DpjQR3icJi1lxm2CvUWpW8oI1-1783062433496"
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
treeData	Array<Object>	LogTreeノードのリストです。ノードのパラメータは下表をご参照ください。トレースデータがない場合は null になることがあります。
summary	Object	メッセージレベルのサマリー情報です。トレースデータがない場合は null になることがあります。
runningStatus	String	全体の実行ステータスです。例：SUCCESS、FAILED、RUNNING。
botId	String	エージェントのIDです。
startTimestampMillis	Long	開始タイムスタンプ（ミリ秒）です。
endTimestampMillis	Long	終了タイムスタンプ（ミリ秒）です。
totalLatencyMillis	Long	合計所要時間（ミリ秒）です。
totalTokens	Long	合計トークン数です。
stepCount	Integer	ステップ数です。返されたLogTreeノードの数から導出されます。
credit	Number	消費クレジットです。クレジットデータがない場合は null になることがあります。
msgId	String	メッセージIDです。
conversationId	String	会話IDです。
traceId	String	トレースIDです。

treeData ノードパラメータ

フィールド	タイプ	説明
children	Array<Object>	子ノードです。構造は本表と同じです。リーフノードでは null が返されることがあります。
actionId	String	ActionのIDです。
traceId	String	トレースIDです。
msgId	String	メッセージIDです。
botId	String	エージェントのIDです。
logComponentId	String	コンポーネントのIDです。
logComponentName	String	コンポーネントの名前です。
logComponentTitle	String	コンポーネントのタイトルです。
logComponentType	String	コンポーネントのタイプです。
isComponent	Boolean	コンポーネントノードであるかどうかです。
actionType	String	Actionのタイプです。
actionName	String	Actionの名前です。
runningStatus	String	ノードの実行ステータスです。
startTimestampMillis	Long	ノードの開始タイムスタンプ（ミリ秒）です。
endTimestampMillis	Long	ノードの終了タイムスタンプ（ミリ秒）です。
latencyMillis	Long	ノードの所要時間（ミリ秒）です。
input	Object/String/Array	ノードの入力です。
output	Object/String/Array	ノードの出力です。
inputTokens	Integer	入力トークン数です。
outputTokens	Integer	出力トークン数です。
totalTokens	Integer/String	合計トークン数です。既存のLogTreeの戻り値の型に準じます。
extension	String/Object	拡張情報です。
createTime	Long	作成タイムスタンプ（ミリ秒）です。
uuid	String	ノードの一意な識別子です。
workflowExecutionId	String	ワークフロー実行IDです。
parentId	String	親ノードのIDです。

失敗時のレスポンス

フィールド	タイプ	説明
code	Integer	エラーコード
message	String	エラーの詳細内容