更新文本类知识文档(文件)
最新更新:
更新文本类知识文档(文件)
用文件批量更新文档。系统将依次执行分块/切片、嵌入/向量化,最后用新文档内容替换掉旧文档内容,但文档 ID 不变。
注:嵌入模型使用的是默认的模型,不可在 API 内定义。
注:仅返回上传结果,不返回最终的嵌入结果。您可以通过“查询文档状态”API 获取最终结果。
请求方式
PUT
调用地址
https://api.gptbots.ai/v1/bot/doc/text/update
调用验证
详情参见【API 概述】内的鉴权方式说明。
请求
请求示例
curl --location --request PUT 'https://api.gptbots.ai/v1/bot/doc/text/update' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"knowledge_base_id": "67457fea6f658672d6482542",
"chunk_token": 600,
"splitter": "\n",
"files": [
{
"doc_id": "675158a5af12af632a4f63f6",
"file_url": "https://www.gptbots.ai/doc/article_1.pdf",
"source_url": "https://www.gptbots.ai/doc/article_1.pdf",
"file_name": "article_1"
}
]
}'
curl --location --request PUT 'https://api.gptbots.ai/v1/bot/doc/text/update' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"knowledge_base_id": "67457fea6f658672d6482542",
"chunk_token": 600,
"splitter": "\n",
"files": [
{
"doc_id": "675158a5af12af632a4f63f6",
"file_url": "https://www.gptbots.ai/doc/article_1.pdf",
"source_url": "https://www.gptbots.ai/doc/article_1.pdf",
"file_name": "article_1"
}
]
}'
此代码块在浮窗中显示
请求头
字段 | 类型 | 描述 |
---|---|---|
Authorization | Bearer ${token} | 使用 Authorization: Bearer ${token} 进行调用验证,请在 API 密钥页面获取密钥作为 token。 |
Content-Type | application/json | 数据类型,取值为 application/json 。 |
请求体
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
files | Array | 是 | 更新的文档列表。最多支持同时更新 200 个文档。 |
doc_id | String | 是 | 更新的文档的 ID。 |
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。 |
source_url | String | 否 | 更新的文档的来源 URL。必须符合 URL 格式规范。 若为空,则系统不对此值进行更新。 若需要将此值设置为空,请输入NULL 。 |
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 | 错误详情。 |