Bot接口会话
创建会话
接口描述
此接口用于创建一个新的会话。创建会话后，您将获得一个唯一的会话 ID，此 ID 可用于后续的发起对话、查看消息详情等操作。创建会话是与 Bot 开启对话的第一步，这使得对话可以被独立管理和追踪，你也可以在创建会话时同步写入消息。
会话、对话、消息和上下文片段的概念说明，可参考基础概念。
基础信息
| 请求地址 | /chat-messages |
|---|---|
| 请求域名 | • 办公网域名：http://jiuwen-api.vmic.xyz/v1 • IDC域名：http://jiuwen-api.vivo.lan:8080/v1 |
| 请求方法 | POST |
请求参数
Request Header
| 参数 | 取值 | 说明 |
|---|---|---|
| Authorization | Bearer {{API-SECRET-KEY}} | 用于验证客户端身份的 API密钥。注意：请只替换红色部分！Bearer和密钥中间有一个空格，请勿删除！ |
| Content-Type | application/json | 响应的HTTP内容类型。 |
Request Body
| 参数 | 类型 | 是否必传 | 默认值 | 说明 |
|---|---|---|---|---|
| query | String | 是 | 用户输入/提问内容。 | |
| inputs | Object | 是 | {} | 以键值对方式提供用户输入字段，与提示词编排中的变量对应。Key 为变量名称，Value 是参数值。如果字段类型为 Select，传入的 Value 需为预设选项之一。 |
| response_mode | String | 否 | blocking | • blocking：阻塞型，等待执行完毕后返回结果。（请求若流程较长可能会被中断）• streaming：流式返回。基于 SSE（Server-Sent Events）实现流式返回。 |
| conversation_id | String | 否 | 不传则开启新对话 | 会话标识符，首次对话可为空，如果要继续对话请传入上下文返回的 conversation_id。 |
| user | String | 是 | 空字符串 | 用户标识，由开发者定义规则，需保证用户标识在应用内唯一。 |
| upload_mediums | List | 否 | [] | 多媒体数据。只支持图片或视频链接.目前只支持一次传一个内容,该链接能够被我方服务器下载.该参数支持图片或视频类型,示例 图片:[{"url":"http://xxxxx/40b.jpg","type":"image"}] 视频:[{"url":"http://xxxxx/40b.mp4","type":"video"}] 链接可通过本地文件上传接口获取 |
返回参数
示例
Request
curl --location --request POST '{{HOST}}/v1/chat-messages' \
--header 'Authorization: Bearer {{API-SECRET-KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"inputs": {},
"query": "eh",
"response_mode": "blocking",
"conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276",
"user": "abc-123",
"upload_mediums": [{"url":"http://ads-marketing-vivofs.vivo.com.cn/NtBrJ9dueygDLoz8/ad/img/20250313/d27c21ad3cff48c78f7b3c8b08b9e40b.jpg","type":"image"}]
}'注意： 请只替换
{{API-SECRET-KEY}}！Bearer和密钥中间有一个空格，请勿删除！
Response
- blocking
{ "answer": "Hi, is there anything I can help you?", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "created_at": 1679587005, "id": "059f87d9-15c0-473a-870c-fde95cdcc1e4" } - streaming
data: {"id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": " I", "created_at": 1679586595} data: {"id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "answer": " I", "created_at": 1679586595}