LoadAgentSession - 加载恢复Agent会话详情

更新时间:
复制 MD 格式

加载已有 Agent 会话的历史消息,以 SSE 返回,用于页面刷新和异常后的历史恢复。

接口说明

请求说明

  • 该接口用于恢复指定会话的详情,并通过 SSE(Server-Sent Events)以流式方式返回 Agent 的响应。

  • 如果目标会话不存在,则会返回一个错误帧,错误码为 400。

  • 响应中包含 Agent 处理请求的过程信息,如消息分片、思考过程、工具调用状态更新等。

  • stopReason字段指示了 Agent 停止本轮对话的原因,可能值包括但不限于达到最大轮次限制、被取消等。

  • 返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范,具体可以参考:https://agentclientprotocol.com

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:LoadAgentSession

none

*全部资源

*

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

Jsonrpc

string

否

JSON-RPC 版本,固定 2.0

2.0

Id

string

否

请求方传入的 id,原样回显

4as3dasf654a

Params

object

否

业务参数

Meta

object

否

DataWorks 的 ACP 扩展参数

BeginLogOffset

integer

否

断点续传场景下,基于指定的位置拉取 SSE 的后续输出

10000

IsReload

boolean

否

是否是断点续传场景,在 SSE 流不稳定的场景下,比如网络不稳定,导致 SSE 中途断了,可以基于该标志标识从断点点位置重新拉取 SSE 返回数据

true

SessionId

string

否

目标会话 ID,不存在会返回 SSE error 帧

sess_0f12abc34

返回参数

名称

类型

描述

示例值

object

Error

any

SSE 的帧信息错误提示,返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范,具体可以参考:https://agentclientprotocol.com/protocol/prompt-turn

{"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null}

Id

string

请求方传入的 id,原样回显

676303114031776

Jsonrpc

string

JSON-RPC 版本,固定 2.0

2.0

Method

string

SSE 的 method,返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范,具体可以参考:https://agentclientprotocol.com/protocol/prompt-turn

session/update

Params

any

SSE 的 params,返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范,具体可以参考:https://agentclientprotocol.com/protocol/prompt-turn

{"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"hello world"}}}

RequestId

string

Id of the request

0D41C608-0C60-5EB0-B986-1460909CF642

Result

any

SSE 的帧结果集,返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范,具体可以参考:https://agentclientprotocol.com/protocol/prompt-turn

{"stopReason":"end_turn"}

Timestamp

integer

时间戳。

1769479322828

示例

正常返回示例

JSON格式

{
  "Error": "{\"code\": 400, \"errorCode\": \"0x50000000001\", \"message\": \"not exist session\", \"data\": null}",
  "Id": "676303114031776",
  "Jsonrpc": "2.0",
  "Method": "session/update",
  "Params": "{\"sessionId\":\"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed\",\"update\":{\"sessionUpdate\":\"agent_message_chunk\",\"content\":{\"type\":\"text\",\"text\":\"hello world\"}}}",
  "RequestId": "0D41C608-0C60-5EB0-B986-1460909CF642",
  "Result": "{\"stopReason\":\"end_turn\"}",
  "Timestamp": 1769479322828
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。