句子 Insight
  1. 对话
句子 Insight
  • 🍊 句子专属知识库
  • Insight Open API
    • Insight Open API
    • 对话
      • 对话接口
        POST
      • 开始语音通话
        POST
      • 结束语音通话
        POST
    • 流程引擎
      • 获取流程引擎事件列表
      • 获取流程引擎执行历史
      • 添加历史消息到流程引擎
      • 触发流程引擎事件
      • 创建批量执行任务
      • 追加子任务
      • 提交批量任务
    • 知识库
      • 文档
        • 段落
          • 获取段落列表
          • 创建段落
          • 更新段落
          • 删除段落
        • 获取文档列表
        • 获取文档详情
        • 创建文档
        • 更新文档信息
        • 删除文档
        • 创建文档-自动分段
      • 网页
        • 创建网页-自动分段
      • 获取知识库列表
      • 获取知识库信息
      • 创建知识库
      • 更新知识库信息
      • 删除知识库
    • 回调接口
      • 点赞踩回调
      • 批量任务子任务执行结果回调
    • 获取 access token
      POST
  1. 对话

对话接口

POST
/openapi/bot/message

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数application/json
botId
string 
机器人id
必需
可以在管理后台机器人页面的url里获取
sessionId
string 
会话id
必需
系统通过这个id来维护当前会话的上下文
message
消息
必需
当前的消息
Any of
文本内容消息
history
array [object {2}] 
可选
text
string 
消息文本
必需
具体的消息内容
isSelf
boolean 
是否是机器人发送
必需
当是true时,代表这条消息是机器人发送的消息,当是false的时候,代表这条消息是客户发送的
stream
boolean 
流式返回
可选
是否开启流式返回
示例
{
    "botId": "5eCcf701-D91E-1C36-46b1-6F64e1D5eEf8",
    "sessionId": "iNyO8",
    "message": {
        "type": "text",
        "text": "Kyilg wugk wecypk kwgqw uloo ldbnvdgf hpnp njfqj nrjrncgdl ydfwyltr glvpn qqo ryixglwcae kugsjqdk xdve mozvoje lkqkn."
    },
    "history": [
        {
            "text": "但识金极光育六或代程新算经称相。",
            "isSelf": false
        },
        {
            "text": "单转无划十般关手毛理术风权。",
            "isSelf": false
        },
        {
            "text": "根华易定间九层易名县花影们。",
            "isSelf": false
        },
        {
            "text": "区明观给看接儿更温电然亲院一交。",
            "isSelf": false
        },
        {
            "text": "目门走族国低型音作县酸织手土格系。",
            "isSelf": true
        }
    ],
    "stream": false
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://insight.juzibot.com/openapi/bot/message' \
--header 'Content-Type: application/json' \
--data-raw '{
    "botId": "5eCcf701-D91E-1C36-46b1-6F64e1D5eEf8",
    "sessionId": "iNyO8",
    "message": {
        "type": "text",
        "text": "Kyilg wugk wecypk kwgqw uloo ldbnvdgf hpnp njfqj nrjrncgdl ydfwyltr glvpn qqo ryixglwcae kugsjqdk xdve mozvoje lkqkn."
    },
    "history": [
        {
            "text": "但识金极光育六或代程新算经称相。",
            "isSelf": false
        },
        {
            "text": "单转无划十般关手毛理术风权。",
            "isSelf": false
        },
        {
            "text": "根华易定间九层易名县花影们。",
            "isSelf": false
        },
        {
            "text": "区明观给看接儿更温电然亲院一交。",
            "isSelf": false
        },
        {
            "text": "目门走族国低型音作县酸织手土格系。",
            "isSelf": true
        }
    ],
    "stream": false
}'

返回响应

🟢200成功
application/json
Body
code
integer 
返回码
必需
0 代表成功,其他错误码代表不同的错误
data
object 
数据
必需
message
string 
消息
必需
生成的回答
handover
boolean 
转人工标识
可选
当这个值为true的时候,说明知识库按照既定配置,进入到了转人工的逻辑里,需要调用程序进行额外的逻辑处理
domain
string 
进入的分类
可选
当机器人配置了分类器的时候,这个字段有可能会被返回。分类器代表了机器人对当前聊天内容的分析和处理。这个字段的值代表了当前这个问答消息被归类到了哪个分类进行的处理
msgId
string 
消息ID
必需
用来唯一标识一条消息的ID
references
array [object {3}] 
引用数组
可选
回复消息时引用的相关知识库内容
fileUrls
array[string]
回复文件链接
可选
当流程生成的回复消息是语音消息或者文件消息的时候,会将对应的语音或文件的链接放入这个值里,需要根据后缀判断类型
示例
{
    "code": 0,
    "data": {
        "message": "string",
        "handover": true,
        "domain": "string",
        "msgId": "string",
        "references": [
            {
                "similarity": "string",
                "content": "string",
                "reference": {
                    "type": "string",
                    "source": {
                        "id": "string",
                        "question": "string",
                        "answer": "string",
                        "reviewed": "string",
                        "generated": "string",
                        "updatedBy": "string",
                        "createdBy": "string"
                    }
                }
            }
        ],
        "fileUrls": [
            "string"
        ]
    }
}
修改于 2024-12-09 03:42:52
上一页
Insight Open API
下一页
开始语音通话
Built with