logo
开发者文档
搜索
添加QA对切片

添加QA对切片

可以通过该接口,向已有的QA知识文档中追加QA对切片(知识块)。支持批量添加,每个切片可附带自定义关键词。

请求方式

POST

调用地址

https://api.gptbots.ai/v1/bot/doc/qa/chunks/add

调用验证

详情参见 API 概述 的鉴权方式说明。

请求

请求示例

curl -X POST https://api.gptbots.ai/v1/bot/doc/qa/chunks/add \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json' \ -d '{ "doc_id": "680d1a2b3c4d5e6f7a8b9c0d", "chunks": [ { "question": "如何联系客服?", "answer": "您可以通过官网右下角的在线客服按钮联系我们,工作时间为周一至周五 9:00-18:00。", "keywords": ["客服", "联系方式", "在线客服"] }, { "question": "退款流程是什么?", "answer": "登录账号后进入订单管理页面,选择需要退款的订单,点击申请退款并填写原因即可。", "keywords": ["退款", "退货", "订单"] } ] }'
                      
                      curl -X POST https://api.gptbots.ai/v1/bot/doc/qa/chunks/add \
  -H 'Authorization: Bearer your_apikey' \
  -H 'Content-Type: application/json' \
  -d '{
      "doc_id": "680d1a2b3c4d5e6f7a8b9c0d",
      "chunks": [
        {
          "question": "如何联系客服?",
          "answer": "您可以通过官网右下角的在线客服按钮联系我们,工作时间为周一至周五 9:00-18:00。",
          "keywords": ["客服", "联系方式", "在线客服"]
        },
        {
          "question": "退款流程是什么?",
          "answer": "登录账号后进入订单管理页面,选择需要退款的订单,点击申请退款并填写原因即可。",
          "keywords": ["退款", "退货", "订单"]
        }
      ]
    }'

                    
此代码块在浮窗中显示

请求头

字段 类型 描述
Authorization Bearer ${token} 使用 Authorization: Bearer ${token}进行调用验证,请在 API 密钥页面获取密钥作为 token。
Content-Type application/json 数据类型,取值为 application/json。

请求体

字段 类型 必填 描述
doc_id string 目标QA知识文档的id,文档类型须为 qa 或 qafile。
chunks list QA对切片列表,不可为空。
question string 问题内容。
answer string 答案内容。
keywords list 关键词列表,每个切片最多50个关键词。

chunks 列表不可为空,每个切片的 question 和 answer 均为必填。
每个切片的 keywords 最多支持50个,超过将返回错误。

响应

响应示例

{ "code": 0, "message": "OK" }
                      
                      {
    "code": 0,
    "message": "OK"
}

                    
此代码块在浮窗中显示

成功响应

字段 类型 描述
code int 状态码,0表示成功。
message string 状态信息。

失败响应

字段 类型 描述
code int 错误码。
message string 错误描述信息

错误码

Code Message
40000 参数错误
50000 系统内部错误