Skip to main content

AI模型与工具

所有AI相关接口都需要有效的访问令牌。请确保在请求头中包含正确的Bearer令牌。

AI模型管理

模型管理功能

AI模型管理接口提供了创建、查询、更新和删除AI模型的功能。支持多种AI服务,包括OpenAI、Claude、Dify和百度。

获取模型列表

/ai/models
获取可用的AI模型列表,支持分页查询。
GET /ai/models?page=1&limit=10
Authorization: Bearer YOUR_ACCESS_TOKEN

请求参数

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

创建AI模型

/ai/models
创建新的AI模型配置。
{
  "name": "GPT-4模型",
  "desc": "OpenAI的GPT-4模型配置",
  "service": "openai",
  "conf": {
    "model": "gpt-4",
    "temperature": 0.7
  }
}
创建模型时请确保配置参数符合相应AI服务的要求。不同服务的配置参数可能不同。

更新AI模型

/ai/models/{modelId}
更新指定AI模型的配置信息。
{
  "name": "更新后的模型名称",
  "desc": "更新后的描述",
  "service": "openai",
  "conf": {
    "model": "gpt-4",
    "temperature": 0.8
  }
}

路径参数

参数名类型必选说明
modelIdstring模型ID

删除AI模型

/ai/models/{modelId}
删除指定的AI模型。
DELETE /ai/models/model123
Authorization: Bearer YOUR_ACCESS_TOKEN
删除模型操作不可恢复,请谨慎操作。

AI工具管理

工具管理功能

AI工具管理接口提供了创建、查询、更新和删除AI工具的功能。工具可以包含多个动作配置,支持灵活的处理流程。

获取工具列表

/ai/tools
获取可用的AI工具列表,支持分页查询。
GET /ai/tools?page=1&limit=10
Authorization: Bearer YOUR_ACCESS_TOKEN

请求参数

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

创建AI工具

/ai/tools
创建新的AI工具。
{
  "name": "文本分析工具",
  "desc": "用于分析文本内容的工具",
  "service": "text-analysis",
  "conf": {},
  "actions": [
    {
      "name": "分析情感",
      "type": "sentiment",
      "conf": {}
    }
  ]
}
工具可以配置多个动作,每个动作都需要指定名称、类型和配置。

执行工具

/ai/tools/{toolId}/run
执行指定的AI工具。
{
  "content": "需要分析的文本内容",
  "convId": "conversation123",
  "msgId": "message123",
  "hook": "before",
  "data": {},
  "send": true
}

请求参数

参数名类型必选说明
contentstring执行内容
convIdstring对话ID
msgIdstring消息ID
hookstring钩子类型
dataobject附加数据
sendboolean是否发送消息
执行工具时请确保提供了正确的对话ID和消息ID,这些信息用于追踪工具执行的上下文。

错误码说明

错误码

错误码说明
400请求参数错误
404工具不存在
500服务器错误