获取智能体短期记忆

更新时间不可用

获取用户和智能体对话的短期记忆。

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

你可以在智能体运行期间 (RUNNING) 调用该 API 获取智能体创建到现在储存的短期记忆信息,包括:

  • 智能体创建和停止的时间戳
  • 用户和智能体对话消息

鉴权

Basic Auth

使用 HTTP 基本认证时,将由客户 ID 和客户密钥生成的凭证填入 HTTP 请求的 Authorization Header。具体生成方法请参考实现 HTTP 鉴权。

Agora Token

推荐使用 Token 认证。请参考实现 HTTP 鉴权生成 Token,并填入 HTTP 请求的 Authorization Header。传参示例:Authorization: agora token="007abcxxxxxxx123"。

路径参数

appidstring
必填

你的项目使用的 App ID。

agentIdstring
必填

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

请求 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

智能体唯一标识。

start_tsinteger

智能体创建时间戳。

statusstring

智能体运行状态。仅支持查询状态为 RUNNING (2),即正在运行的智能体。

智能体短期记忆。

请求示例

Example Request
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?"
    }
  ]
}