查询对话轮次信息
更新时间不可用
在与智能体会话结束后,调用该接口分页查询本次会话的对话轮次信息,包含每个对话轮次的开始信息、结束信息、性能指标。
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]。
Authorizationstring发送 HTTP 请求时,你可以从以下鉴权方式中任选其一:
- 使用 Token 认证(推荐):参考实现 HTTP 鉴权生成 Token 并填入
AuthorizationHeader。传参示例:Authorization: agora token="007abcxxxxxxx123"。 - 使用 Basic Auth:参考实现 HTTP 鉴权生成 Base64 编码的
Authorization字段。传参示例:Authorization: Basic NDI1OTQ3N2I4MzYy...YwZjA=。
响应
- 若返回的状态码为
200则表示请求成功。响应包体中包含本次请求的结果。 - 若返回的状态码不为
200则表示请求失败。响应包体中包含错误的类别和描述,你可以参考响应状态码了解可能的原因。
响应 Body
agent_idstring智能体唯一标识。
namestring智能体名称。
channelstring对话频道名称。
total_turn_countinteger当前会话中的对话轮次总数。
分页信息。
page_indexinteger当前页码,从 1 开始。
total_pagesinteger总页数。
is_last_pageboolean当前页是否为最后一页。
对话轮次列表。
agent_idstring智能体唯一标识。
channelstring对话频道名称。
turn_idinteger对话轮次 ID,从 1 开始递增。
轮次开始信息。
start_atinteger开始时间戳,毫秒级 UTC 时间。
typestring开始类型:
voice_input:因用户语音输入而开始。greeting:因智能体播报问候语而开始。silence_timeout:因智能体静音超时而开始。api_speak:因调用播报自定义信息接口播报信息而开始。api_think:因 API 调用思考而开始。
开始附加元数据,根据 type 字段的不同,包含不同的字段。
语音输入附加元数据。
speech_duration_msinteger语音持续时长(ms)。
interrupt_duration_msinteger智能体空闲或倾听时的人声持续阈值 (ms)。
问候语附加元数据。
greeting_nthinteger问候语播放次数。
静默超时附加元数据。
actionstringspeak:播报静默提示内容。think:将静默提示内容追加在上下文的最后,并传递给 LLM。
播报自定义信息附加元数据。
transportstring传输协议:
http:HTTP 协议。rtm:通过 RTM Presence 通道传输。
API 调用思考附加元数据。
轮次结束信息。
end_atinteger结束时间戳,毫秒级 UTC 时间。
typestring轮次结束类型:
ok:正常结束。interrupted:被中断。ignored:被忽略。error:执行错误。
结束附加元数据,根据 type 字段的不同,包含不同的字段。
正常结束附加元数据。
playback_duration_msinteger语音播放时长(ms)。
中断附加元数据。
playback_duration_msinteger中断发生时,当前轮次已实际播放的 PCM 音频时长(ms)。
intended_playback_duration_msinteger当前轮次中计划播放的 PCM 音频总时长(ms),包含尚未播放完的排队音频。
transportstring传输协议(caused_by 为 api_speak、api_interrupt 或 api_think 时返回):
http:HTTP 协议。rtm:通过 RTM Presence 通道传输。
忽略附加元数据。
caused_bystring错误附加元数据。
reasonstring错误类型,可能包含以下值:
LLM_REQUEST_ERR:LLM 请求错误。TTS_REQUEST_ERR:TTS 请求错误。INTERNAL_ERR:内部错误。
detailsstring错误详情。
对话轮次性能指标详情。
e2e_latency_msinteger端到端总延迟 (ms)。
分段延迟指标详情列表。
延迟模块名称,根据创建对话式智能体时设置的 LLM 输入模态的不同,返回不同的延迟模块。
latencyinteger延迟时间 (ms)。
请求示例
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
}
]
}
}
]
}