调用GetChatContent API从指定检查点流式获取聊天内容-数据管理DMS-阿里云

接口说明

请求说明

响应将以 SSE 流的形式返回，其中每个事件都遵循SSEEvent模式，包含有关消息级别的元信息等。
每个 SSE 事件中的content字段可能携带实际的消息文本或 JSON 对象，具体取决于content_type的值。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v1/chat/stream HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
DMSUnit	string	否	当前所在的 DMS 单元，阿里云国内站用户默认填入 cn-hangzhou。	cn-hangzhou
SessionId	string	否	会话 ID，必须字段	sess_12345
AgentId	string	否	AgentId，必填	xxxx-xxxx-xxxx
Checkpoint	string	否	后端将从这个接口开始返回输出	0

返回参数

名称	类型	描述	示例值
	object	SSE 响应流的每条 data 都符合该 json 结构
content	string	消息内容	Data understanding completed.
event_type	string	消息的类型，用于区分控制符和具体消息。如 `CHAT_START`表示 Agent 的一次回复开始，`CHAT_FINISH`表示 Agent 的一次回复结束。`DATA`表示这是一条携带了内容的消息，`DELTA`表示这是一条增量输出的消息的一部分.	DATA
content_type	string	content 字段的类型，可取值: `[str, json]`。当取值为 json 时，content 字段可进一步解析为 json 结构	str
checkpoint	integer	Checkpoint 值。	0
level	integer	消息的输出级别，级别越高越重要	20
category	string	消息的类别，用于辅助 json 类型的 content 的解析。如`PLAN`表示该消息是执行计划的展示，会符合执行计划的 Schema。	PLAN

示例

正常返回示例

JSON格式

{
  "content": "Data understanding completed.",
  "event_type": "DATA",
  "content_type": "str",
  "checkpoint": 0,
  "level": 20,
  "category": "PLAN"
}

错误码

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

变更历史

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