Skip to content

对话API接口文档(HTTP SSE)

HTTP SSE 是单向通道,客户端发起 HTTP 请求之后,服务端持续推送流式数据到客户端,此时不支持双向交互。

1. HTTP SSE 接口请求

请求地址: /api/objs/lke/v1/sse/chat

请求方式:POST

注意:

触发对话接口前,需要有已发布的应用。

1.1 参数说明

请放到 HTTP Body 中, 以 JSON 的形式发送,具体如下:

名称类型是否必填说明
contentstring(6000)消息内容,如果发送图片,在此传递 markdown 格式的图片链接,例如![](图片连接),其中图片链接需要可公有读。
sessionIdstring(64)会话 ID,用于标识一个会话(外部系统提供,建议不同的用户端会话传入不同的 session_id,否则同一个应用下的不同用户的消息记录会串掉)

参数长度:2-64个字符

校验规则: ^[a-zA-Z0-9_-]{2,64}$ ,一般可以用 uuid 来生成该值

uuid 示例:1b9c0b03-dc83-47ac-8394-b366e3ea67ef
appkeystring(8)应用密钥
appCodestring(6)发布的应用code
docIdsarray引用的知识库id集合

1.2 如何获取AppKey和AppCode

在应用管理界面,找到您处于运行中的应用(需要先发布),单击发布管理,会弹出“调用信息”窗口。可在图示查找AppKey和AppCode。

预览

1.3 Postman调用

预览