Skip to main content

对话管理

所有对话管理接口都需要有效的访问令牌。请确保在请求头中包含正确的Bearer令牌。

对话功能概述

对话管理接口提供了创建、查询、更新和删除对话的功能,以及消息的发送和管理功能。支持流式响应和工具调用。

对话管理

创建对话

/conversation
创建新的对话。
{
  "name": "技术咨询",
  "botId": "bot123",
  "conf": {
    "title": "关于AI开发的咨询",
    "description": "技术架构讨论"
  },
  "members": ["user123"]
}
创建对话时可以指定参与者列表,如果不指定则默认只包含创建者。

获取对话列表

/conversation
获取对话列表,支持分页查询。
GET /conversation?page=1&limit=10&hdId=device123
Authorization: Bearer YOUR_ACCESS_TOKEN

请求参数

参数名类型必选说明
pageinteger页码
limitinteger每页数量
hdIdstring硬件设备ID

获取对话详情

/conversation/{convId}
获取指定对话的详细信息。
GET /conversation/conv123
Authorization: Bearer YOUR_ACCESS_TOKEN

路径参数

参数名类型必选说明
convIdstring对话ID

更新对话

/conversation/{convId}
更新指定对话的信息。
{
  "name": "更新后的名称",
  "conf": {
    "title": "更新后的标题",
    "description": "更新后的描述"
  }
}
更新操作会覆盖现有的配置信息,请确保提供完整的配置对象。

删除对话

/conversation/{convId}
删除指定的对话。
DELETE /conversation/conv123
Authorization: Bearer YOUR_ACCESS_TOKEN
删除操作不可恢复,会同时删除对话中的所有消息记录。

消息管理

消息功能说明

消息管理接口提供了发送消息、获取消息历史、执行消息和工具调用等功能。支持流式响应和自动工具调用。

获取消息列表

/conversation/{convId}/messages
获取指定对话的消息历史记录。
GET /conversation/conv123/messages?page=1&limit=20
Authorization: Bearer YOUR_ACCESS_TOKEN

请求参数

参数名类型必选说明
pageinteger页码
limitinteger每页数量

发送消息

/conversation/{convId}/messages
向指定对话发送新消息。
{
  "content": "请帮我分析这段代码的性能问题",
  "attrs": {
    "stream": true,
    "tool_auto": true,
    "isDebug": false
  }
}
设置stream=true时将返回流式响应,tool_auto=true时将自动调用相关工具。

执行消息

/conversation/{convId}/messages/run
执行新的消息,支持流式响应和工具调用。
{
  "content": "分析这段代码的复杂度",
  "stream": true,
  "tool_auto": true,
  "isDebug": false
}

请求参数

参数名类型必选说明
contentstring消息内容
streamboolean是否使用流式响应
tool_autoboolean是否自动调用工具
isDebugboolean是否开启调试模式
流式响应会通过WebSocket推送消息内容,请确保已建立WebSocket连接。

重新执行消息

/conversation/{convId}/messages/{msgId}/run
重新执行指定的消息。
{
  "content": "使用新的参数重新分析",
  "stream": true,
  "tool_auto": true,
  "isDebug": false
}

路径参数

参数名类型必选说明
convIdstring对话ID
msgIdstring消息ID

工具调用响应

/conversation/{convId}/messages/{msgId}/tool
响应工具调用请求。
{
  "tool_call_id": "call123",
  "content": "工具执行结果"
}

请求参数

参数名类型必选说明
tool_call_idstring工具调用ID
contentstring执行结果
工具调用响应会触发后续的消息处理流程,可能产生新的消息。

错误码说明

错误码说明
400请求参数错误
404对话或消息不存在
500服务器错误