StartChat - 创建或继续ROS Agent V2会话

更新时间:
复制 MD 格式

通过SSE流式返回智能体事件,支持创建新会话或继续已有会话。

接口说明

请求说明

  • 调用此 API 时,请确保AgentVersion设置为V2

  • 如果不提供SessionId,则将创建一个新的会话;如果提供了SessionId,则将继续已有的会话。

  • Mode默认值为IaCCodeNormal,仅支持IaCCodeNormalIaCCodePipeline两种模式,并且已有会话不能切换模式。

  • EnableThinking默认为true,表示是否输出思考内容,可以在每次请求中重新设置。

  • 支持最多 5 个图片附件,每个附件最大 5 MiB,必须通过当前用户目录下的 OssObjectKey 访问。

  • ClientContext是页面上下文 JSON 字符串,最大 16 KiB,仅在IaCCodeNormal模式下有效。

  • 响应类型为text/event-stream,HTTP 连接成功并不意味着业务完成,需要继续读取 SSE 直到终态。

  • 当接收到TASK_STATE_INPUT_REQUIRED状态时,表示等待用户输入,这并不是失败状态。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ros:StartChat

none

*全部资源

*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

Query

string

用户输入,不能为空或仅包含空白字符。

创建一个 VPC 和 VSwitch 的 ROS 模板

SessionId

string

不传则创建新会话;传入则继续当前用户已有会话。

7f4e2a8c6d9b4a1f8e3c5b7d2a6f9012

EnablePartialMessage

boolean

兼容字段。V2 始终通过 SSE 返回事件流,当前服务不消费该字段。

true

Mode

string

V2 仅支持 IaCCodeNormal 或 IaCCodePipeline;新会话默认 IaCCodeNormal,已有会话不能切换模式。

IaCCodeNormal

Attachments

array<object>

图片附件数组,最多 5 个;当前仅支持 image 类型。

[{"Type":"image","MimeType":"image/png","Name":"topology.png","OssObjectKey":"user-id/attachments/topology.png"}]

object

单个附件对象。

{}

MimeType

string

图片媒体类型,支持 image/png、image/jpeg、image/webp、image/gif。

image/png

Name

string

附件文件名;不传时从 OssObjectKey 获取文件名。

topology.png

OssObjectKey

string

当前用户目录下的 OSS object key,不能包含绝对路径或路径穿越。

user-id/attachments/topology.png

Type

string

附件类型。V2 当前只支持 image。

image

Url

string

V2 暂不支持 URL 直传,请使用 OssObjectKey。

https://example.com/topology.png

AgentVersion

string

传 V2 路由到 ROS Agent V2 后端。

V2

EnableThinking

boolean

是否输出 thinking 内容,默认 true;同一会话重入时可按请求重新设置。

true

RegionId

string

本次资源操作的地域。

cn-hangzhou

返回参数

名称

类型

描述

示例值

string

SSE 事件流。每个 frame 以 data: 开头并以空行结束;请持续读取直到业务终态。

data: {"event":"..."}

示例

正常返回示例

JSON格式

"data: {\"event\":\"...\"}\n\n"

错误码

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

变更历史

更多信息,参考变更详情