QAnything
搜索 K

主题

Agent 管理 ​

创建 Agent ​

shell
curl --location --request POST 'https://openapi.youdao.com/q_anything/api/bot/create' \
--header 'Authorization: {{apikey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "kbIds":["KB248e8e079642491383596f63c2ab069a_240430"],
    "botName": "产品客服",
    "botDescription": "解答用户对产品的问题",
    "model": "QAnything 4o mini",
    "maxToken": "1024",
    "hybridSearch": "false",
    "networking": "true",
    "needSource": "true",
    "botPromptSetting":"你是一个XXX专家。",
    "welcomeMessage": "您好，我是您的专属机器人，请问有什么可以帮您呢？\n[介绍一下你的功能]\n[你能提供什么服务]"
}'
json
{
  "kbIds": ["KB248e8e079642491383596f63c2ab069a_240430"], //绑定知识库id （必填）
  "botName": "产品客服", // Agent名称，长度不超过20字符（必填）
  "botDescription": "解答用户对产品的问题", // Agent描述，长度不超过200字符
  "model": "QAnything 4o mini", // 模型选择，取值：QAnything 4o mini，QAnything 4o，deepseek-pro，deepseek-lite,deepseek-chat
  "maxToken": 1024, // 最大回复token限制，QAnything 4o mini范围：512-1024 默认512；QAnything 4o：1024-4096默认1024；QAnything 16k：1024-4096默认1024
  "hybridSearch": false, // 是否开启混合检索，true或false，默认false
  "networking": true, // 是否开启联网检索，true或false，默认false
  "needSource": true, // 是否需要来源信息，true或false，默认true
  "botPromptSetting": "你是一个XXX专家。", // 角色设定
  "welcomeMessage": "您好，我是您的专属机器人，请问有什么可以帮您呢？\n[介绍一下你的功能]\n[你能提供什么服务]" // 欢迎语
}
json
{
  "errorCode": 0, // 错误码
  "msg": "SUCCESS", // 描述
  "requestId": "38e4e659-13a7-45ea-b8c5-484979348b43", // 请求id
  "result": {
    "uuid": "C1BDCFC4F33747E7", // agent的uuid
    "name": "产品客服", // agent名称
    "description": "解答用户对产品的问题", // 描述
    "promptSetting": "", // 角色设定
    "welcomeMessage": "您好，我是您的专属机器人，请问有什么可以帮您呢？\n[介绍一下你的功能]\n[你能提供什么服务]", // 欢迎语
    "model": "QAnything 4o mini", // 首选模型
    "maxToken": 1024, // 回复上限
    "hybridSearch": false, // 是否开启混合检索
    "networking": true, // 是否开启联网检索
    "needSource": true // 是否需要来源信息
  }
}

更新 Agent ​

更新 Agent 接口不支持绑定/解绑知识库。

shell
curl --location --request POST 'https://openapi.youdao.com/q_anything/api/bot/update' \
--header 'Authorization: {{apikey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uuid": "C1BDCFC4F33747E7",
    "botName": "产品客服2",
    "botDescription": "可以解答用户对产品的问题",
    "model": "QAnything 16k",
    "maxToken": "4096",
    "hybridSearch": "true",
    "networking": "true",
    "needSource": "true",
    "botPromptSetting":"你是一个XXX专家。",
    "welcomeMessage": "您好，我是您的专属机器人，请问有什么可以帮您呢？\n[介绍一下你的功能]\n[你能提供什么服务]"
}'
json
{
  "uuid": "C1BDCFC4F33747E7", // Agent uuid（必填）
  "botName": "产品客服2", // Agent名称，长度不超过20字符
  "botDescription": "可以解答用户对产品的问题", // Agent描述，长度不超过200字符
  "model": "QAnything 16k", // 模型选择，取值：QAnything 4o mini，QAnything 4o，deepseek-pro，deepseek-lite,deepseek-chat
  "maxToken": 4096, // 最大回复token限制，QAnything 4o mini范围：512-1024 默认512；QAnything 4o：1024-4096默认1024；QAnything 16k：1024-4096默认1024
  "hybridSearch": true, // 是否开启混合检索，true或false，默认false
  "networking": true, // 是否开启联网检索，true或false，默认false
  "needSource": true, // 是否需要来源信息，true或false，默认true
  "botPromptSetting": "你是一个XXX专家。", // 角色设定
  "welcomeMessage": "您好，我是您的专属机器人，请问有什么可以帮您呢？\n[介绍一下你的功能]\n[你能提供什么服务]" // 欢迎语
}
json
{
  "errorCode": 0, // 错误码
  "msg": "SUCCESS", // 描述
  "requestId": "38e4e659-13a7-45ea-b8c5-484979348b43", // 请求id
  "result": {
    "uuid": "C1BDCFC4F33747E7", // agent的uuid
    "name": "产品客服2", // agent名称
    "description": "可以解答用户对产品的问题", // 描述
    "promptSetting": "", // 角色设定
    "welcomeMessage": "您好，我是您的专属机器人，请问有什么可以帮您呢？\n[介绍一下你的功能]\n[你能提供什么服务]", // 欢迎语
    "model": "QAnything 16k", // 首选模型
    "maxToken": 4096, // 回复上限
    "hybridSearch": true, // 是否开启混合检索
    "networking": true, // 是否开启联网检索
    "needSource": true // 是否需要来源信息
  }
}

删除 Agent ​

shell
curl --location --request POST 'https://openapi.youdao.com/q_anything/api/bot/delete' \
--header 'Authorization: {{apikey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uuid": "C1BDCFC4F33747E7"
}'
json
{
  "uuid": "C1BDCFC4F33747E7" // Agent uuid（必填）
}
json
{
  "errorCode": 0, // 错误码
  "msg": "SUCCESS", // 描述
  "requestId": "9454b20a-2788-4eeb-a057-08d78b10ef4a", // 请求id
  "result": null
}

查询 Agents 列表 ​

shell
curl --location --request GET 'https://openapi.youdao.com/q_anything/api/bot/list' \
--header 'Authorization: {{apikey}}' \
json
{
  "errorCode": 0, // 错误码
  "msg": "SUCCESS", // 描述
  "requestId": "3402a048-cc30-46a1-839e-318b81ca85ee", // 请求id
  "result": [
    {
      "uuid": "C1BDCFC4F33747E7", // agent的uuid
      "name": "产品客服2", // agent名称
      "description": "可以解答用户对产品的问题", // 描述
      "promptSetting": "", // 角色设定
      "welcomeMessage": "您好，我是您的专属机器人，请问有什么可以帮您呢？\n[介绍一下你的功能]\n[你能提供什么服务]", // 欢迎语
      "model": "QAnything 16k", // 首选模型
      "maxToken": 4096, // 回复上限
      "hybridSearch": true, // 是否开启混合检索
      "networking": true, // 是否开启联网检索
      "needSource": true // 是否需要来源信息
    }
  ]
}

Agent 绑定知识库 ​

单个Agent最多绑定100个知识库，如果当前请求中新增绑定的知识库+已经绑定的知识库>100，当前绑定操作会失败。

shell
curl --location --request POST 'https://openapi.youdao.com/q_anything/api/bot/bindKbs' \
--header 'Authorization: {{apikey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uuid": "489DA044XXXXXXXX",
    "kbIds": [
        "KB1283228f8f054299a639b5b22e91XXXX_240430",
        "KB031fcea9ca6c457783bf8030fb0cXXXX_240430",
        "KB5c87bb08eb44401ab3ccf8e9f424XXXX_240430"
    ]
}'
json
{
    "uuid": "C1BDCFC4F33747E7" // Agent uuid（必填）
    "kbIds": [
        "KB248e8e079642491383596f63c2abxxxx_240430",
        "KB248e8e079642491383596f63c2acxxxx_240430"
    ] // 知识库id列表（必填）
}
json
{
    "errorCode": "0", // 错误码
    "msg": "SUCCESS", // 描述
    "requestId": "38e4e659-13a7-45ea-b8c5-484979348b43", // 请求id
    "result": 1 // 绑定知识库数量
}

Agent 解绑知识库 ​

shell
curl --location --request POST 'https://openapi.youdao.com/q_anything/api/bot/unbindKbs' \
--header 'Authorization: {{apikey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uuid": "489DA044XXXXXXXX",
    "kbIds": [
        "KB1283228f8f054299a639b5b22e91XXXX_240430",
        "KB031fcea9ca6c457783bf8030fb0cXXXX_240430",
        "KB5c87bb08eb44401ab3ccf8e9f424XXXX_240430"
    ]
}'
json
{
    "uuid": "C1BDCFC4F33747E7" // Agent uuid（必填）
    "kbIds": [
        "KB248e8e079642491383596f63c2abxxxx_240430",
        "KB248e8e079642491383596f63c2acxxxx_240430"
    ] // 知识库id列表（必填）
}
json
{
    "errorCode": "0", // 错误码
    "msg": "SUCCESS", // 描述
    "requestId": "38e4e659-13a7-45ea-b8c5-484979348b43", // 请求id
    "result": 1 // 解除绑定知识库数量
}

查询 Agent 详情（问答秘钥和管理秘钥均可以查询） ​

shell
curl --location --request GET 'https://openapi.youdao.com/q_anything/api/bot/detail?uuid=80981E69F9A34C15' \
--header 'Authorization: {{apikey}}' \
json
{
  "errorCode": "0", // 错误码
  "msg": "SUCCESS", // 描述
  "requestId": "9983934e-05c1-43ee-afe0-bdf0bbe58d31", // 请求id
  "result": {
    "uuid": "", // agent的uuid
    "name": "", // agent名称
    "description": "", // 描述
    "promptSetting": "", // 角色设定
    "welcomeMessage": "", // 欢迎语
    "model": "QAnything 4o mini", // 首选模型
    "maxToken": 512, // 回复上限
    "hybridSearch": false, // 是否开启混合检索
    "networking": false, // 是否开启联网检索
    "needSource": false, // 是否需要来源信息
    "kbBindList": [
      //绑定的知识库id列表
      {
        "kbId": "KB0bf4921097f04f6d83efb14db475df5e_240430", //知识库id
        "kbName": "456" //知识库名字
      }
    ]
  }
}

基于 MIT 许可发布

版权所有 © 2019-2025 尤雨溪