textChat

通过 API 方式发起对话,服务端流式返回响应结果。

接口信息

URL

https://api.xxx.com/soulmate/chat/v1

请求方式

POST

权限说明

文本对话

请求参数

Header

字段名称
类型
必选
说明

Authorization

string

Bearer ${accessToken} 获取方式参考获取授权页面

Body

字段名称
类型
必选
说明

requestId

String

每次请求唯一标识。建议使用 UUID

messages

array

对话消息历史

botId

String

终端设备唯一标识,每个终端用户必须是用不同的botId

sessionId

String

会话唯一标识。 会话是智能体和用户之间的一段问答交互。一个会话包含一条或多条对话消息记录。当使用相同sessionId时,智能体可以自动加载会话上下文,无须设置对话消息历史。

Message

字段名称
类型
必选
说明

role

string

角色类型(user/assistant)

content

string

消息内容

请求示例

sessionId使用说明

响应参数

Body(SSE流式格式)

名称
类型
必选
说明

id

string

64

object

string

固定值"chat.completion.chunk"

choices

array

响应内容数组,包含单个结果

Choice

名称
类型
必选
说明

delta.content

string

流式返回的文本内容(UTF-8编码)

delta.role

string

角色类型(assistant/system/user)

finish_reason

string

结束原因(stop:正常结束/length:长度限制/content_filter:内容过滤)

响应示例说明

接口采用SSE(Server-Sent Events)流式返回,每个事件以data: 开头,以两个换行符\n\n结束

响应示例

Last updated