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: b1ed2db5-1af8-42c7-ab34-bd89b4c6eb6c' \
--form 'sessionSn="session-478edddd6d8c432cb2f6a"' \
--form 'msgContent="查询圆周率前10位数"' \
--form 'msgType="master"' \
--form 'delayInMs="20"' \
--form 'stream="true"' \
--form 'files=@""' \
--form 'promptParamValues="{\"name\":\"变量名称\",\"value\":\"1221\",\"type\":\"text\"}"' \
--form 'promptParamValues="{\"name\":\"变量名称\",\"value\":\"1243\",\"type\":\"string\"}"' \
--form 'promptParamValues="{\"name\": \"自定义文本\", \"type\": \"radio\", \"value\": \"[\\\"选项1\\\",\\\"选项2\\\"]\"}"'

返回响应

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

示例
data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393977001,"time":"2024/06/26 17:26:17","content":{"answer":"","steps":[{"status":0,"stage":"初始化","messages":["正在初始化"],"loading":true}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393977657,"time":"2024/06/26 17:26:17","content":{"answer":"","steps":[{"status":0,"stage":"模型调用","messages":["正在调用大模型"],"loading":true}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393979434,"time":"2024/06/26 17:26:19","content":{"answer":"","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":0,"stage":"使用技能: 音频解析","messages":["{\"32c1a97037\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":true}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983021,"time":"2024/06/26 17:26:23","content":{"answer":"","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false},{"status":0,"stage":"模型调用","messages":["正在调用大模型"],"loading":true}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983664,"time":"2024/06/26 17:26:23","content":{"answer":"抱","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983676,"time":"2024/06/26 17:26:23","content":{"answer":"歉","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983687,"time":"2024/06/26 17:26:23","content":{"answer":",","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983699,"time":"2024/06/26 17:26:23","content":{"answer":"无","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983711,"time":"2024/06/26 17:26:23","content":{"answer":"法","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983723,"time":"2024/06/26 17:26:23","content":{"answer":"找","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983735,"time":"2024/06/26 17:26:23","content":{"answer":"到","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983747,"time":"2024/06/26 17:26:23","content":{"answer":"该","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983759,"time":"2024/06/26 17:26:23","content":{"answer":"音","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983771,"time":"2024/06/26 17:26:23","content":{"answer":"频","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983783,"time":"2024/06/26 17:26:23","content":{"answer":"文件","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983795,"time":"2024/06/26 17:26:23","content":{"answer":",请","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983807,"time":"2024/06/26 17:26:23","content":{"answer":"确认","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983819,"time":"2024/06/26 17:26:23","content":{"answer":"文件","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983831,"time":"2024/06/26 17:26:23","content":{"answer":"是否","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983843,"time":"2024/06/26 17:26:23","content":{"answer":"存在","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983855,"time":"2024/06/26 17:26:23","content":{"answer":"并","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983867,"time":"2024/06/26 17:26:23","content":{"answer":"稍","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983879,"time":"2024/06/26 17:26:23","content":{"answer":"后","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983891,"time":"2024/06/26 17:26:23","content":{"answer":"再","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983903,"time":"2024/06/26 17:26:23","content":{"answer":"试","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

data:{"code":0,"success":true,"data":{"msgSn":"2553e22c-f0a7-4e4d-845f-e8c793911d6b","msgTime":1719393983915,"time":"2024/06/26 17:26:23","content":{"answer":"。","steps":[{"status":1,"stage":"思考分析","messages":["模型选择调用:音频解析"],"loading":false},{"status":1,"stage":"使用技能: 音频解析","messages":["{\"音频\":\"abc170706cab4983ad380ca0b8a9a085/b1cb083863ca45a5820fadf5762fda4f\"}"],"loading":false},{"status":1,"stage":"观察结果","messages":["{\"errorMessage\":\"语音识别:文件不存在\"}"],"loading":false}],"functionCalled":null,"outputs":null,"answerPreview":null}},"message":"操作成功"}

修改于 2024-12-17 06:55:02
上一页
Agent对话-知识检索
下一页
Agent对话-信息收集
Built with