添加文本类知识文档（文件）

批量上传文本类文件，并依次执行分块/切片、嵌入/向量化及储存。

注：嵌入模型使用的是默认的模型，不可在 API 内定义。

注：仅返回上传结果，不返回最终的嵌入结果。您可以通过“查询文档状态”API 获取最终结果。

请求方式

POST

调用地址

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

调用验证

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

请求

请求示例

curl --location 'https://api.gptbots.ai/v1/bot/doc/text/add' \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "knowledge_base_id": "67457fea6f658672d6482542", "chunk_token": 700, "splitter": "\n", "files": [ { "file_url": "https://www.gptbots.ai/docs/article_1.pdf", "file_base64": "SGVsbG8sIEJhc2U2NCBFbmNvZGluZyE=", "source_url": "https://www.gptbots.ai/docs/article_1.pdf", "file_name": "article_1" } ] }'

          curl --location 'https://api.gptbots.ai/v1/bot/doc/text/add' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "knowledge_base_id": "67457fea6f658672d6482542",
    "chunk_token": 700,
    "splitter": "\n",
    "files": [
        {
            "file_url": "https://www.gptbots.ai/docs/article_1.pdf",
            "file_base64": "SGVsbG8sIEJhc2U2NCBFbmNvZGluZyE=",
            "source_url": "https://www.gptbots.ai/docs/article_1.pdf",
            "file_name": "article_1"
        }
    ]
}'

此代码块在浮窗中显示

请求头

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

请求体

字段	类型	必填	说明
knowledge_base_id	String	否	文档添加的目标知识库。若不填写，则默认添加至“Default”知识库。
files	Array	是	添加的文档列表。最多支持同时添加 200 个文档。
file_url	String	否	添加的文档的 URL。文档支持的格式：pdf/txt/md/doc/docx。PDF 文档最大 30MB，其他格式最大 10MB。注：URL 和 base64 二选一。当同时入参时，优先使用 base64。
file_base64	String	否	添加的文档的 base64。文档支持的格式：pdf/txt/md/doc/docx。PDF 文档最大 30MB，其他格式最大 10MB。注：URL 和 base64 二选一。当同时入参时，优先使用 base64。
file_name	String	是	添加的文档的名称。1-200 字符。
source_url	String	否	添加的文档的来源 URL。必须符合 URL 格式规范。
chunk_token	Integer	否	分块时，单个知识块的最大 Token 数。默认值为 600。填写范围 1-1000。注：最大 Token 数和分隔符二选一。当同时入参时，优先使用分隔符。
splitter	String	否	分块时，使用的分隔符。默认空。可使用“\n”作为换行分隔符。注：最大 Token 数和分隔符二选一。当同时入参时，优先使用分隔符。

响应

响应示例

{ "doc": [ { "doc_id": "xxxxxx", "doc_name": "test_1.txt" }, { "doc_id": "xxxxxx", "doc_name": "test_2.pdf" } ] }

          {
    "doc": [
        {
            "doc_id": "xxxxxx",
            "doc_name": "test_1.txt"
        },
        {
            "doc_id": "xxxxxx",
            "doc_name": "test_2.pdf"
        }
    ]
}

此代码块在浮窗中显示

成功响应

字段	类型	说明
doc	Array	添加的文档列表。
doc_id	String	添加的文档的 ID。
doc_name	String	添加的文档的名称。

失败响应

字段	类型	描述
code	Integer	错误码。
message	String	错误详情。