SendAsyncChatMessage - 异步发送会话消息

更新时间:
复制 MD 格式

异步发送会话消息

接口说明

异步发送会话消息。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

winnexo:SendAsyncChatMessage

none

*全部资源

*

无 无

请求语法

POST /openapi/sendAsyncChatMessage HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

tenantId

string

否

租户 ID,公共参数,缺省时使用调用方默认租户

10000

content

string

是

用户消息正文

示例内容

contentType

string

否

消息类型:Text / Markdown

Text

sessionId

string

否

会话 ID,不传则新建会话

exampleSessionId

digitalEmployeeName

array

否

数字员工名称列表(兼容旧格式可传单个字符串)

string_value

string

否

数字员工名称。

pcitc-magent

model

string

否

抽象模型档位(quick / standard / flagship);缺省时新会话用 standard,已有会话沿用会话当前档位

quick

files

array<object>

否

文件引用列表;每项为对象,fileId 必传(由 uploadChatFile 返回)

object

否

文件引用列表;每项为对象,fileId 必传(由 uploadChatFile 返回)。

fileId

string

是

文件 ID,由 uploadChatFile 返回

exampleFileId

type

string

否

文件类型

text

stream

boolean

否

是否流式生成;本接口固定按流式生成后台内容并写入消息流,取值不改变返回结构

true

reuseLastSession

boolean

否

不传 sessionId 时是否复用该数字员工下最近一个会话(CLI 场景),缺省 false 即新建会话

false

directChat

boolean

否

是否启用直连模式;true 时跳过常规场景路由,直接进入直连对话场景

false

enableWebSearch

boolean

否

是否启用联网搜索,默认 False;任务执行场景(传 taskExecution)下以任务配置为准

false

workMode

string

否

会话工作模式:ask=快速问答(裁剪工具/技能/连接器,单轮直答);work=深度工作(默认);direct=直连模式(请求级:不启动沙箱、无上下文污染,等同 directChat=true)。ask/work 为会话级:新建会话时选定后即固化,续聊时默认继承会话模式;显式传值与会话模式不一致时返回参数错误(如需切换,请新建会话或 Fork)。多数字员工或任务执行场景传 ask 时按 work 生效;directChat=true 时本参数被忽略。

work

taskExecution

object

否

executeScheduledTask 返回的任务执行元数据;传入后按任务执行链路处理

billingId

string

否

计费 ID

exampleBillingId

enableWebSearch

boolean

否

是否启用联网搜索

true

executionId

string

是

执行记录 ID

exampleExecutionId

operatingObjectName

string

否

数字员工名称

string_value

skillCodes

array

否

关联技能编码列表

string_value

string

否

关联技能编码列表。

code

taskId

string

是

任务 ID

exampleTaskId

taskName

string

否

任务名称

string_value

taskUnderstand

string

否

任务理解内容

string_value

tenantId

string

否

任务所属租户 ID

10000

userId

string

否

任务所属用户 ID

exampleUserId

返回参数

名称

类型

描述

示例值

object

返回结果。

code

string

业务状态码:成功为 200,失败为后端错误码(ERR.* / InvalidParameter.*)

200

message

string

错误描述,成功时为空

successful

messageId

string

助手消息 ID;用于随后调用 streamChatMessage 订阅生成结果

3cf84d92-f273-4bb7-ab3c-52646d25ec30

requestId

string

请求追踪 ID

019FF406-1B10-0065-A97D-2D1920C2A03D

sessionCreated

boolean

本次调用是否新建了会话

true

sessionId

string

会话 ID;续写会话时与入参一致,新建会话时为服务端生成值

bd772dcc-afab-44ad-9fb8-bca716726201

userMessageId

string

用户消息 ID。

60756cc6-8c53-4d1f-8db8-b8c09b81a5cb

workMode

string

本轮实际生效的会话工作模式:ask=快速问答;work=深度工作;direct=直连模式(请求级)。多数字员工或任务执行场景传 ask 时按 work 生效。

work

示例

正常返回示例

JSON格式

{
  "code": "200",
  "message": "successful",
  "messageId": "3cf84d92-f273-4bb7-ab3c-52646d25ec30",
  "requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
  "sessionCreated": true,
  "sessionId": "bd772dcc-afab-44ad-9fb8-bca716726201",
  "userMessageId": "60756cc6-8c53-4d1f-8db8-b8c09b81a5cb",
  "workMode": "work"
}

错误码

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

变更历史

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