添加QA对知识文档

可以通过该接口，向 Agent 知识库中添加QA对知识文档。支持三种方式：直接传入QA文本、上传QA格式文件（CSV）、上传文档自动转换为QA对。

请求方式

POST

调用地址

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

调用验证

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

请求

请求示例

QA文本方式：

curl -X POST https://api.gptbots.ai/v1/bot/doc/qa/add \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json' \ -d '{ "purpose": "QA_TEXT", "name": "常见问题", "knowledge_base_id": "673af861ed69656ac0895b07", "qaList": [ { "question": "如何注册账号？", "answer": "点击首页右上角的注册按钮，填写邮箱和密码即可完成注册。" }, { "question": "如何重置密码？", "answer": "在登录页面点击忘记密码，按提示操作即可重置。" } ] }'

                      
                      curl -X POST https://api.gptbots.ai/v1/bot/doc/qa/add \
  -H 'Authorization: Bearer your_apikey' \
  -H 'Content-Type: application/json' \
  -d '{
      "purpose": "QA_TEXT",
      "name": "常见问题",
      "knowledge_base_id": "673af861ed69656ac0895b07",
      "qaList": [
        {
          "question": "如何注册账号？",
          "answer": "点击首页右上角的注册按钮，填写邮箱和密码即可完成注册。"
        },
        {
          "question": "如何重置密码？",
          "answer": "在登录页面点击忘记密码，按提示操作即可重置。"
        }
      ]
    }'

此代码块在浮窗中显示

QA文件方式：

curl -X POST https://api.gptbots.ai/v1/bot/doc/qa/add \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json' \ -d '{ "purpose": "QA_FILE", "knowledge_base_id": "673af861ed69656ac0895b07", "files": [ { "file_url": "https://example.com/qa.csv", "file_name": "qa_data.csv" } ] }'

                      
                      curl -X POST https://api.gptbots.ai/v1/bot/doc/qa/add \
  -H 'Authorization: Bearer your_apikey' \
  -H 'Content-Type: application/json' \
  -d '{
      "purpose": "QA_FILE",
      "knowledge_base_id": "673af861ed69656ac0895b07",
      "files": [
        {
          "file_url": "https://example.com/qa.csv",
          "file_name": "qa_data.csv"
        }
      ]
    }'

此代码块在浮窗中显示

文档转QA方式：

curl -X POST https://api.gptbots.ai/v1/bot/doc/qa/add \ -H 'Authorization: Bearer your_apikey' \ -H 'Content-Type: application/json' \ -d '{ "purpose": "FILE_2_QA", "knowledge_base_id": "673af861ed69656ac0895b07", "files": [ { "source_url": "https://example.com/product_manual.pdf", "file_name": "产品手册.pdf" } ] }'

                      
                      curl -X POST https://api.gptbots.ai/v1/bot/doc/qa/add \
  -H 'Authorization: Bearer your_apikey' \
  -H 'Content-Type: application/json' \
  -d '{
      "purpose": "FILE_2_QA",
      "knowledge_base_id": "673af861ed69656ac0895b07",
      "files": [
        {
          "source_url": "https://example.com/product_manual.pdf",
          "file_name": "产品手册.pdf"
        }
      ]
    }'

此代码块在浮窗中显示

请求头

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

请求体

字段	类型	必填	描述
purpose	string	是	数据类型，可选值：`QA_TEXT`（QA文本）、`QA_FILE`（QA格式文件）、`FILE_2_QA`（文档转QA）。
knowledge_base_id	string	否	知识库id，不传则使用默认知识库。
name	string	条件必填	文档名称，当 purpose 为 `QA_TEXT` 时必填。
qaList	list	条件必填	QA对列表，当 purpose 为 `QA_TEXT` 时必填。
question	string	是	问题内容。
answer	string	是	答案内容。
files	list	条件必填	文件列表，当 purpose 为 `QA_FILE` 或 `FILE_2_QA` 时必填，最多20个文件。
source_url	string	是	文件来源URL。
file_name	string	是	文件名称。
doc_id	string	否	文档id。
file_url	string	否	文件URL。
file_base64	string	否	文件的base64编码内容。
header_row	int	否	表头行号。
chunk_token	int	否	分片token数，默认600。
splitter	string	否	分隔符。

当 purpose 为 QA_TEXT 时，必须提供 name 和 qaList。
当 purpose 为 QA_FILE 或 FILE_2_QA 时，必须提供 files，且最多支持20个文件。

响应

响应示例

{ "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	系统内部错误