向智能体发送对话消息,支持SSE,可创建新会话或在已有会话中继续对话。
接口说明
请求说明
通过此 API 可以向智能体发送对话消息,并且支持服务器发送事件(SSE)。
如果提供了
ConversationId参数,则会在指定的已有会话上下文中继续对话;若未提供,则自动创建一个新的会话。Config字段允许用户传递额外的信息输入,必须是 JSON 格式。当请求成功时,响应将包含本次对话的消息 ID、回复内容等信息;如果发生错误,也会返回相应的错误码和错误消息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v1/conversations/chat HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 Body。 |
{} |
| InstanceId |
string |
是 |
实例 ID。 |
learn-pairec-xxx |
| ConversationId |
string |
否 |
会话 ID。不传则创建新会话,传入则在已有会话上下文中继续对话。 |
e47cfae9-c0cc-42e1-91e2-e67cdb0e7b96 |
| Content |
string |
是 |
消息内容。 |
校验引擎配置 |
| Config |
string |
否 |
额外信息输入,JSON 格式。 |
{} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 id。 |
728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77 |
| ConversationId |
string |
会话 ID。 |
e47cfae9-c0cc-42e1-91e2-e67cdb0e7b96 |
| MessageId |
string |
消息 ID。 |
chat-abcdefg |
| Event |
string |
事件。 |
message |
| Answer |
string |
回复内容。 |
FeatureDB近7天读写量为xxx |
| GmtCreateTime |
string |
创建时间。 |
2021-12-15T23:24:33.132+08:00 |
| ErrorCode |
string |
错误码。 |
SERVER_ERROR |
| ErrorMessage |
string |
错误消息。 |
connection failed |
| SkillName |
string |
"" |
|
| Func |
string |
"" |
|
| CallId |
string |
"" |
示例
正常返回示例
JSON格式
{
"RequestId": "728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77",
"ConversationId": "e47cfae9-c0cc-42e1-91e2-e67cdb0e7b96",
"MessageId": "chat-abcdefg",
"Event": "message",
"Answer": "FeatureDB近7天读写量为xxx",
"GmtCreateTime": "2021-12-15T23:24:33.132+08:00",
"ErrorCode": "SERVER_ERROR",
"ErrorMessage": "connection failed",
"SkillName": "\"\"",
"Func": "\"\"",
"CallId": "\"\""
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。