跳转到主要内容
POST
/
datasets
/
{dataset_id}
/
documents
/
{document_id}
/
update-by-file
用文件更新文档
curl --request POST \
  --url http://{apiBaseUrl}/datasets/{dataset_id}/documents/{document_id}/update-by-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'data={"name":"new_name.txt","process_rule":{"mode":"automatic"}}' \
  --form file='@example-file'
{
  "document": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "position": 123,
    "data_source_type": "<string>",
    "data_source_info": {},
    "dataset_process_rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_from": "<string>",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": 123,
    "tokens": 123,
    "indexing_status": "<string>",
    "error": "<string>",
    "enabled": true,
    "disabled_at": 123,
    "disabled_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "archived": true,
    "display_status": "<string>",
    "word_count": 123,
    "hit_count": 123,
    "doc_form": "<string>"
  },
  "batch": "<string>"
}

Authorizations

​
Authorization
string
header
required

API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为 Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非分享或者放在客户端存储，以免 API-Key 泄露，导致财产损失。

Path Parameters

​
dataset_id
string<uuid>
required

包含文档的知识库 ID。

​
document_id
string<uuid>
required

要更新的文档 ID。

Body

multipart/form-data
​
data
string

包含可选文档名称和处理规则的 JSON 字符串。请参见 UpdateDocumentByFileRequestData 模式。

Example:

"{\"name\":\"new_name.txt\",\"process_rule\":{\"mode\":\"automatic\"}}"

​
file
file

要上传的新文件。

Response

200 - application/json

文档更新成功。

​
document
object
​
batch
string

用于跟踪索引进度的批次标识符。