获取智能体短期记忆
更新时间不可用
获取用户和智能体对话的短期记忆。
GET
https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/history你可以在智能体运行期间 (RUNNING) 调用该 API 获取智能体创建到现在储存的短期记忆信息,包括:
- 智能体创建和停止的时间戳
- 用户和智能体对话消息
鉴权
appidstring必填
你的项目使用的 App ID。
agentIdstring必填
智能体实例 ID,即智能体的唯一标识。调用 POST 创建对话式智能体 成功后在响应包体中获取。
Authorizationstring必填
发送 HTTP 请求时,你可以从以下鉴权方式中任选其一:
- 使用 Token 认证(推荐):参考实现 HTTP 鉴权生成 Token 并填入
AuthorizationHeader。传参示例:Authorization: agora token="007abcxxxxxxx123"。 - 使用 Basic Auth:参考实现 HTTP 鉴权生成 Base64 编码的
Authorization字段。传参示例:Authorization: Basic NDI1OTQ3N2I4MzYy...YwZjA=。
响应
- 若返回的状态码为
200则表示请求成功。响应包体中包含本次请求的结果。 - 若返回的状态码不为
200则表示请求失败。响应包体中包含错误的类别和描述,你可以参考响应状态码了解可能的原因。
响应 Body
agent_idstring智能体唯一标识。
start_tsinteger智能体创建时间戳。
statusstring智能体运行状态。仅支持查询状态为 RUNNING (2),即正在运行的智能体。
智能体短期记忆。
rolestring消息发送者。可能为以下值:
user:用户。assistant:智能体。
contentstring消息内容。
speech_start_msinteger说话或 TTS 播报开始时间戳,单位为毫秒(Unix 时间戳)。仅在 llm.vendor = custom 时返回。
speech_end_msinteger说话结束、TTS 播报完成或被打断的时间戳,单位为毫秒(Unix 时间戳)。仅在 llm.vendor = custom 时返回。
speech_algorithmic_delayinteger算法处理时延,单位为毫秒。
- 仅当
llm.vendor = custom,contents[].role = user且存在实际语音输入时返回。 - 表示音频从用户设备麦克风采集后,经过降噪、背景人声消除、声纹锁定等算法处理引入的总延迟,可用于进一步对齐云录制原始音频的时间戳。
请求示例
curl --request GET \
--url "https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/:appid/agents/:agentId/history" \
--header 'Authorization: agora token="007abcxxxxxxx123"'响应示例
{
"agent_id": "xxxx",
"start_ts": 123,
"status": "RUNNING",
"contents": [
{
"role": "user",
"content": "hello."
},
{
"role": "assistant",
"content": "hi, how can I help you?"
}
]
}