更新QA对知识文档

可以通过该接口，更新 Agent 知识库中已有的QA对知识文档。支持两种更新方式：替换QA文本内容、更新QA文件。

请求方式

PUT

调用地址

https://api.gptbots.ai/v1/bot/doc/qa/update

调用验证

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

请求

请求示例

QA文本更新方式：

curl -X PUT https://api.gptbots.ai/v1/bot/doc/qa/update \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json' \ -d '{ "doc_id": "680d1a2b3c4d5e6f7a8b9c0d", "knowledge_base_id": "673af861ed69656ac0895b07", "qaList": [ { "question": "如何注册账号？", "answer": "访问官网首页，点击右上角注册按钮，填写邮箱、设置密码并完成邮箱验证即可。" }, { "question": "如何重置密码？", "answer": "在登录页面点击忘记密码链接，输入注册邮箱，按邮件提示操作即可重置。" } ] }'

                      
                      curl -X PUT https://api.gptbots.ai/v1/bot/doc/qa/update \
  -H 'Authorization: Bearer your_apikey' \
  -H 'Content-Type: application/json' \
  -d '{
      "doc_id": "680d1a2b3c4d5e6f7a8b9c0d",
      "knowledge_base_id": "673af861ed69656ac0895b07",
      "qaList": [
        {
          "question": "如何注册账号？",
          "answer": "访问官网首页，点击右上角注册按钮，填写邮箱、设置密码并完成邮箱验证即可。"
        },
        {
          "question": "如何重置密码？",
          "answer": "在登录页面点击忘记密码链接，输入注册邮箱，按邮件提示操作即可重置。"
        }
      ]
    }'

此代码块在浮窗中显示

QA文件更新方式：

curl -X PUT https://api.gptbots.ai/v1/bot/doc/qa/update \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json' \ -d '{ "knowledge_base_id": "673af861ed69656ac0895b07", "files": [ { "doc_id": "680d1a2b3c4d5e6f7a8b9c0d", "source_url": "https://example.com/qa_updated.csv", "file_name": "qa_data_v2.csv" } ] }'

                      
                      curl -X PUT https://api.gptbots.ai/v1/bot/doc/qa/update \
  -H 'Authorization: Bearer your_apikey' \
  -H 'Content-Type: application/json' \
  -d '{
      "knowledge_base_id": "673af861ed69656ac0895b07",
      "files": [
        {
          "doc_id": "680d1a2b3c4d5e6f7a8b9c0d",
          "source_url": "https://example.com/qa_updated.csv",
          "file_name": "qa_data_v2.csv"
        }
      ]
    }'

此代码块在浮窗中显示

请求头

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

请求体

字段	类型	必填	描述
doc_id	string	条件必填	文档id，当使用 qaList 更新QA文本时必填。
knowledge_base_id	string	否	知识库id。
qaList	list	条件必填	QA对列表，传入后将完全替换该文档下的所有QA对。与 files 二选一。
question	string	是	问题内容。
answer	string	是	答案内容。
files	list	条件必填	文件列表，最多20个文件。与 qaList 二选一。
doc_id	string	否	文档id。
source_url	string	是	文件来源URL。
file_name	string	是	文件名称。
file_url	string	否	文件URL。
file_base64	string	否	文件的base64编码内容。
header_row	int	否	表头行号。
chunk_token	int	否	分片token数，默认600。
splitter	string	否	分隔符。

使用 qaList 更新时，会完全替换目标文档下的所有QA对，请确保传入完整的QA列表。
qaList 和 files 二选一，不可同时为空。

响应

响应示例

{ "doc": [ { "doc_id": "680d1a2b3c4d5e6f7a8b9c0d", "doc_name": "常见问题" } ], "failed": [] }

                      
                      {
    "doc": [
        {
            "doc_id": "680d1a2b3c4d5e6f7a8b9c0d",
            "doc_name": "常见问题"
        }
    ],
    "failed": []
}

此代码块在浮窗中显示

成功响应

字段	类型	描述
doc	list	成功更新的文档列表。
doc_id	string	文档id。
doc_name	string	文档名称。
failed	list	更新失败的文件名称列表。

失败响应

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

错误码

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