UploadDocument - 上传文档-数据管理 DMS-阿里云帮助中心

上传文档到知识库

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
KbUuid	string	是	知识库 ID。	kb-***
FileName	string	是	文档名称。	test.md
Location	string	是	输入文件的 OSS Location，格式： DescribeKnowledgeBaseUploadSignature 接口的 UploadDir 字段值 + 文件名。	knowledge_base/1666698629**/kb-*
Description	string	否	文档描述。	test
ChunkSize	integer	否	要切分的知识块大小。默认值为 250，最大值为 2048。	250
ChunkOverlap	integer	否	知识块之间重叠的数据大小。此参数的最大值不能大于 ChunkSize 参数的值，默认值为 50。	50
Separators	array	否	用于分割大量数据的分隔符。说明这是一个重要的参数，决定了数据分块的效果。此参数与由 TextSplitterName 参数指定的分隔器相关。在大多数情况下，您不需要指定此参数。服务器会根据 TextSplitterName 参数的值来分配分隔符。
	string	否	分隔符。	\n
ZhTitleEnhance	boolean	否	指定是否启用标题增强。	false
TextSplitterName	string	否	分隔器的名称。	ChineseRecursiveTextSplitter
DocumentLoaderName	string	否	文档加载器的名称，默认采用 ADBPGLoader。	ADBPGLoader
VlEnhance	boolean	否	指定是否开启复杂文档的 VL 增强内容识别，默认值为 false。	false
SplitterModel	string	否	切分模型，默认值为 qwen3-8b。	qwen3-8b

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。	67E910F2-4B62-5B0C-ACA3-7547695C****
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。
ErrorCode	string	错误码，请求异常时返回。	KnowledgeBaseNotFound
ErrorMessage	string	调用失败时，返回的错误信息。	Resource not found kb-***
Data	OneMetaKnowledgeBaseDocument	返回结构体

示例

正常返回示例

JSON格式

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Success": true,
  "ErrorCode": "KnowledgeBaseNotFound",
  "ErrorMessage": "Resource not found kb-***",
  "Data": {
    "KbUuid": "",
    "Name": "",
    "Description": "",
    "FileExt": "",
    "DocumentLoaderName": "",
    "TextSplitterName": "",
    "GmtCreate": "",
    "GmtModified": "",
    "FileSize": 0,
    "DocsCount": 0,
    "State": 0,
    "Summary": "",
    "Keywords": ""
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。