1. agent
askxbot开放API
  • askxbot-openapi使用说明
    • 概述
    • 交互技术说明
    • Agent会话调用接口流程
  • agent
    • agent查询
      GET
    • Agent对话-session创建
      POST
    • Agent对话-智能会话
      POST
    • Agent对话-知识检索
      POST
    • Agent对话-自定义
      POST
    • Agent对话-信息收集
      POST
    • Agent对话-对话流
      POST
    • agent统计日志
      GET
    • agent日志详情
      GET
    • 会话消息点赞/踩
      POST
    • 会话消息修正
      POST
    • 会话消息重试-智能会话
      POST
    • 会话消息重试-知识检索
      POST
    • Agent对话-更新用户定义的变量值
      POST
  • 工作流
    • 工作流查询
      GET
    • 工作运行记录
      GET
    • 工作流输入变量查询
      GET
    • 工作流运行
      POST
  • 知识库
    • 文档知识库
      • v2-多级文档知识库目录
        • 创建子目录文档
        • 子级目录文档树形结构
        • 更新子级文档知识库
        • 删除子级文档知识库
      • 文档知识库列表
      • 文档知识库详情
      • 创建文档知识库
      • 更新文档知识库
      • 删除文档知识库
      • 重试失败文档知识
      • 查询指定文档知识库全部知识
      • 向文档知识库添加知识
      • 更新指定文档知识库指定知识
      • 查询指定文档知识库指定知识
      • 删除指定文档知识库指定知识
    • 问答知识库
      • 问答知识库列表
      • 问答知识库详情
      • 创建问答知识库
      • 更新问答知识库
      • 删除文档知识库
      • 重试失败问答知识
      • 导出问答知识库所有问答知识
      • 查询指定问答知识库全部问答
      • 向问答知识库添加问答
      • 更新指定问答知识库指定问答
      • 删除指定问答知识库指定问答
  • 数据模型
    • Knowledge
      • FaqInventoryCreateDto
      • DocumentInventoryDocumentUpdateDto
      • PageFaqInventorySearchVo
      • DocumentInventoryDocumentDetailVo
      • EmbeddingConfig
      • UpdateEmbeddingConfig
      • FaqInventoryCreateVo
      • FaqInventoryCreateWrapper
      • FaqInventoryFaqSearchVo
      • FaqInventorySearchVo
      • DocumentInventorySearchWrapper
      • PageDocumentInventoryDocumentSearch
      • DocumentInventoryDetailVo
      • PageFaqInventoryFaqSearchVo
      • DocumentInventoryDocumentSearchVo
      • DocumentInventoryDetailWrapper
      • AgentInfo
      • PageDocumentInventorySearchVo
      • DocumentInventorySearchVo
      • DocumentInventoryCreateDto
      • StringResultVo
      • DocumentInventoryDocumentSearchWrapper
      • DocumentInventoryDocumentDetailWrapper
      • FaqInventorySearchWrapper
      • FaqInventoryDetailVo
      • FaqInventoryDetailWrapper
      • FaqInventoryUpdateDto
      • FaqInventoryFaqSearchWrapper
      • FaqInventoryFaqAddDto
      • FaqInventoryFaqUpdateDto
  1. agent

Agent对话-智能会话

POST
https://api.xbotspace.com/agent-api/v1/open/agents/chat
该接口使用sse技术开发（具体细节可查阅网上教程），通过服务器与客户端的http长连接，根据传递的delayInMs间隔返回消息，每次返回的消息格式为json
样例数据：
可将每次返回json中的data.content.answer拼接，即可获得完整的回复内容，回复完成后服务器会自动断开链接
data中其他字段描述：
字段描述备注
sessionSn会话唯一标识
msgSn消息唯一标识
source消息来源：user用户 bot机器人 system系统
msgTime消息发送时间
content消息体
content.answer消息内容

请求参数

Header 参数

Body 参数multipart/form-data

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://api.xbotspace.com/agent-api/v1/open/agents/chat' \
--header 'Authorization: db67f3f2-23b2-4c3c-b47f-1ef23839a94c' \
--form 'sessionSn="session-c17b42e00ba04f1f9fd98"' \
--form 'msgContent="你好"' \
--form 'msgType="text"' \
--form 'delayInMs="20"' \
--form 'stream="true"' \
--form 'promptParamValues="{\"name\":\"变量名称\",\"value\":\"abcd\",\"type\":\"text\"}"' \
--form 'promptParamValues="{\"name\":\"变量名称\",\"value\":\"abcd\",\"type\":\"string\"}"' \
--form 'promptParamValues="{\"name\": \"自定义文本\", \"type\": \"radio\", \"value\": \"选项1\"}"'

返回响应

🟢200成功
text/event-stream
Bodytext/event-stream

示例
data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752552,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":""}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752792,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"你"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752816,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"好"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752838,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"！"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752860,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"有"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752881,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"什"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752904,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"么"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752926,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"我"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752947,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"可以"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752968,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"帮"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304752990,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"助"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304753013,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"你"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304753036,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"的"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304753059,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"吗"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304753080,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":"？"}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"sessionSn":"session-c17b42e00ba04f1f9fd98","msgSn":"4368a92d-8c80-4ab0-a2c5-ab5fd84ebffe","msgType":"text","source":"bot","msgStatus":"normal","msgTime":1719304753102,"rate":0,"success":true,"time":"2024/06/25 16:39","content":{"answer":""}},"message":"操作成功"}
修改于 2024-12-17 06:55:37
上一页
Agent对话-session创建
下一页
Agent对话-知识检索
Built with