查询对话轮次信息

更新时间不可用

在与智能体会话结束后,调用该接口分页查询本次会话的对话轮次信息,包含每个对话轮次的开始信息、结束信息、性能指标。

GET
https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/turns

注意

自 v2.7 起,该接口从单次返回全部对话轮次改为分页返回。默认请求第 1 页,默认每页返回 50 条对话轮次数据。 仅支持查询 7 天内的会话。

路径参数

appidstring
必填

你的项目使用的 App ID。

agentIdstring
必填

智能体实例 ID,即智能体的唯一标识。调用 POST 创建对话式智能体 成功后在响应包体中获取。

查询参数

page_indexinteger

页码。从 1 开始。默认值为 1。

page_sizeinteger

每页返回的对话轮次数量。默认值为 50,取值范围为 [10,200]。

请求 Header

Authorizationstring
必填

发送 HTTP 请求时,你可以从以下鉴权方式中任选其一:

  1. 使用 Token 认证(推荐):参考实现 HTTP 鉴权生成 Token 并填入 Authorization Header。传参示例:Authorization: agora token="007abcxxxxxxx123"。
  2. 使用 Basic Auth:参考实现 HTTP 鉴权生成 Base64 编码的 Authorization 字段。传参示例:Authorization: Basic NDI1OTQ3N2I4MzYy...YwZjA=。

响应

  • 若返回的状态码为 200 则表示请求成功。响应包体中包含本次请求的结果。
  • 若返回的状态码不为 200 则表示请求失败。响应包体中包含错误的类别和描述,你可以参考响应状态码了解可能的原因。

响应 Body

字段
agent_idstring

智能体唯一标识。

namestring

智能体名称。

channelstring

对话频道名称。

total_turn_countinteger

当前会话中的对话轮次总数。

分页信息。

对话轮次列表。

请求示例

Example Request
curl --request GET \
  --url "https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/:appid/agents/:agentId/turns" \
  --header 'Authorization: agora token="007abcxxxxxxx123"'

响应示例

{
  "agent_id": "A42Axxxxxxxxx37MT56J",
  "name": "support_agent_001",
  "channel": "test_channel",
  "total_turn_count": 250,
  "pagination": {
    "page_index": 1,
    "total_pages": 5,
    "is_last_page": false
  },
  "turns": [
    {
      "agent_id": "A42Axxxxxxxxx37MT56J",
      "channel": "test_channel",
      "turn_id": 1,
      "start": {
        "start_at": 1774579820147,
        "type": "greeting",
        "metadata": {
          "greeting_nth": 1
        }
      },
      "end": {
        "end_at": 1774579822412,
        "type": "interrupted",
        "metadata": {
          "caused_by": "api_interrupt",
          "transport": "rtm",
          "playback_duration_ms": 1200,
          "intended_playback_duration_ms": 2400
        }
      },
      "metrics": {
        "e2e_latency_ms": 337,
        "segmented_latency_ms": [
          {
            "name": "tts_ttfb",
            "latency": 337
          }
        ]
      }
    }
  ]
}