Skip to main content
post/datasets/{dataset_id}/document/create-by-text
Request example
Response
post/datasets/{dataset_id}/document/create-by-text

Authorization

Authorizationstringheaderrequired#

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401(unauthorized)。

Path parameters

dataset_idstringrequired#
知识库 ID,通过 获取知识库列表 获取。使用限定范围的密钥时,从 Dify 页面 URL 复制 ID。

Body

application/json
doc_formenum<string>#
text_model 为标准文本分段,hierarchical_model 为父子分段结构,qa_model 为问答对提取。

Default: "text_model"

Options:text_modelhierarchical_modelqa_model
doc_languagestring#
用于处理优化的文档语言。

Default: "English"

embedding_modelstring#
嵌入模型名称。使用 获取可用模型 中 model_type=text-embedding 返回的 model 字段值。
embedding_model_providerstring#
嵌入模型供应商。使用 获取可用模型 中 model_type=text-embedding 返回的 provider 字段值。
indexing_techniqueenum<string>#
向知识库添加首个文档时必填。后续文档如果省略此字段,将继承知识库的索引方式。high_quality 使用嵌入模型进行精确搜索;economy 使用基于关键词的索引。
Options:high_qualityeconomy
namestringrequired#
文档名称。
original_document_idstring#
用于版本控制的原始文档 ID。从 获取知识库的文档列表 获取。
process_ruleobject#
分块处理规则。
retrieval_modelobject#
textstringrequired#
文档文本内容。

Responses

application/json
文档创建成功。
batchstring#
用于跟踪索引进度的批次 ID。
documentobject#