创建对话

一次对话包含用户问和智能体回答两个动作

标签：对话

请求说明

字段	值
请求地址	https://openapi.wps.cn/v7/devhub/apps/{app_id}/chats/create
HTTP 方法	POST
接口描述	开始对话
签名方式	KSO-1
限频策略	无
权限要求	智能体对话管理(用户授权) kso.devhub_chat.readwrite

路径参数 (Path)

属性名	类型	是否必填	描述	可选值
app_id	string	是		-

请求体(Body)

请求体格式: application/json

没有可用的数据

请求体示例

{
  "files": [
    "string"
  ],
  "session_id": "string",
  "stream": true,
  "text": "string",
  "variables": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

{
  "data": {
    "chat_id": "string",
    "session_id": "string"
  },
  "code": 0,
  "msg": "string"
}

非流式对话响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	响应数据
∟ session_id	string	会话id，请求参数中如果没传会话id则会新生成一个会话，并返回id
∟ chat_id	string	对话id

非流式响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "session_id":"xxxxxxxxx",
        "chat_id":"xxxxxxxxxxx"
    }
}

流式响应

响应结果是多个流式消息，每个流式消息结构体如下

*字段*	*字段类型*	*说明*	*示例*	*备注*
event	str	触发事件类型	message
data	object	事件关联信息
|-- role	str	发送这条消息的实体。取值：*user*：代表该条消息内容是用户发送的。*assistant*：代表该条消息内容是智能体发送的。（默认assistant）	assistant
|-- type	str	消息类型。*ack*：用户输入内容。*answer*：智能体返回给用户的消息内容，支持增量返回。*answer_chunk：*智能体返回给用户的消息内容（流式返回内容）*function_call*：智能体对话过程中调用函数（function call）的中间结果。*tool_output*：调用工具 （function call、workflow_call）后返回的结果。*workflow_call:* 工作流工具调用****tool_error*: 工具调用报错*knowledge_references*：知识库节点*wps_365_authorization：*需要进行授权*error*：调用出错*start*：开始对话*end****：结束对话	answer
|-- run_id	str	agent执行时工具run_id（工具调用节点有此id）
|-- content_chunk	str	消息的chunk内容	”你“	当content_chunk 不为空时流式展示内容。仅1种情况不为空：type=***answer且*****stream 输出过程中时有值content_chunk 与content 互斥，不可能同时有值
|-- content	str	消息的内容，目前支持纯文本	“你好呀！”	当content 不为空时展示content。仅2种情况不为空：非stream 模式输出内容stream输出结束后content为最终内容
|-- content_type	str	消息内容的类型，目前支持text	text
|-- seq_id	int	顺序id，标记每个事件消息的唯一id，递增	1
|-- step	int	标记消息的归属（流式返回下多流式返回归属一个index）	1
|-- parent_step	int	归属哪个父步骤（默认0，无父步骤）	0
|-- chat_id	str	对话id（job_id）	123456789
|-- session_id	str	session_id	123456789
|-- message_id	str	消息id（在message表中有存储记录的message才会有此字段信息 ChatInput ChatOutput）
|-- timestamp	str	时间戳	1749518362341
|-- extra_info	object	存储额外信息