用文本更新文档

更新现有文档的文本内容、名称或处理配置。内容变更时将重新触发索引——使用返回的 batch ID 配合 获取文档嵌入状态（进度） 跟踪进度。

POST /datasets/{dataset_id}/documents/{document_id}/update-by-text

Error

A valid request URL is required to generate request examples

200

success

{
  "document": {
    "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
    "position": 1,
    "data_source_type": "upload_file",
    "data_source_info": {
      "upload_file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "data_source_detail_dict": {
      "upload_file": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "guide.txt",
        "size": 2048,
        "extension": "txt",
        "mime_type": "text/plain",
        "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
        "created_at": 1741267200
      }
    },
    "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
    "name": "guide.txt",
    "created_from": "api",
    "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
    "created_at": 1741267200,
    "tokens": 512,
    "indexing_status": "completed",
    "error": null,
    "enabled": true,
    "disabled_at": null,
    "disabled_by": null,
    "archived": false,
    "display_status": "available",
    "word_count": 350,
    "hit_count": 0,
    "doc_form": "text_model",
    "doc_metadata": [],
    "summary_index_status": null,
    "need_summary": false
  },
  "batch": "20250306150245647595"
}

授权

Authorization · string · header · 必填

API Key 认证。对于所有 API 请求，请在 Authorization HTTP 头中包含您的 API Key，并加上 Bearer 前缀。示例：Authorization: Bearer {API_KEY}。强烈建议将 API Key 存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。

路径参数

dataset_id · string<uuid> · 必填

知识库 ID。

document_id · string<uuid> · 必填

文档 ID.

请求体

application/json

name · string

文档名称。当提供 text 时必填。

text · string

文档文本内容。

process_rule · object

分块处理规则。

Show child attributes

doc_form · enum<string> · 默认值: text_model

text_model 为标准文本分段，hierarchical_model 为父子分段结构，qa_model 为问答对提取。

可用选项: text_model, hierarchical_model, qa_model

doc_language · string · 默认值: English

用于处理优化的文档语言。

retrieval_model · object

检索模型配置。控制查询此知识库时如何搜索和排序分段。

Show child attributes

响应

200

application/json

文档更新成功。

document · object

Show child attributes

batch · string

用于跟踪索引进度的批次 ID。