从文件创建文档

通过上传文件在现有知识库中创建新文档。

POST /datasets/{dataset_id}/document/create-by-file

Error

A valid request URL is required to generate request examples

200

{
  "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>"
}

授权

Authorization · string · header · 必填

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

路径参数

dataset_id · string<uuid> · 必填

要添加文档的知识库 ID。

请求体

multipart/form-data

data · string

包含文档元数据和处理规则的 JSON 字符串。详情请参见 CreateDocumentByFileRequestData 模式。

示例:

"{\"indexing_technique\":\"high_quality\",\"process_rule\":{\"mode\":\"custom\", \"rules\": { \"segmentation\":{\"separator\":\"###\", \"max_tokens\":500}}},\"summary_index_setting\":{\"enable\":true,\"model_name\":\"qwen-vl-plus\",\"model_provider_name\":\"langgenius/tongyi/tongyi\",\"summary_prompt\":\"summarize the text\"}}"

file · file

要上传的文件。

响应

200

application/json

文档创建成功，正在被索引。

document · object

显示 子属性

batch · string

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