跳转到主要内容
POST
从文本创建文档

授权

Authorization
string
header
必填

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

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

路径参数

dataset_id
string<uuid>
必填

知识库 ID。从 获取知识库列表 获取。

请求体

application/json
name
string
必填

文档名称。

text
string
必填

文档文本内容。

indexing_technique
enum<string>

向知识库添加首个文档时必填。后续文档如果省略此字段,将继承知识库的索引方式。high_quality 使用嵌入模型进行精确搜索;economy 使用基于关键词的索引。

可用选项:
high_quality,
economy
doc_form
enum<string>
默认值:text_model

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

可用选项:
text_model,
hierarchical_model,
qa_model
doc_language
string
默认值:English

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

process_rule
object

分块处理规则。

retrieval_model
object

控制查询此知识库时如何搜索和排序分段。

embedding_model
string

嵌入模型名称。使用 获取可用模型model_type=text-embedding 返回的 model 字段值。

embedding_model_provider
string

嵌入模型供应商。使用 获取可用模型model_type=text-embedding 返回的 provider 字段值。

original_document_id
string

用于版本控制的原始文档 ID。从 获取知识库的文档列表 获取。

响应

文档创建成功。

document
object
batch
string

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