UploadDocumentAsync - 异步上传文档 - 云原生数据仓库AnalyticDB PostgreSQL版

使用本地文件或公网可免密访问的文件链接异步上传文档，服务端对文档做Loader、Chunk、Embedding然后入库，最大支持200MB。

接口说明

服务端会自动按照文档后缀进行 load 和 chunk，并按照创建文档库（CreateDocumentCollection）时指定的 embedding 模型向量化，然后写入指定的文档库中。支持多种格式的文本、图片多模态 embedding。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	开启了向量引擎优化加速的实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-bp12ga6v69h86****
Collection	string	是	文档库名称。说明由 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。	document
Namespace	string	否	命名空间，默认为 public。说明您可以通过 CreateNamespace 接口创建，通过 ListNamespaces 接口查看列表。	mynamespace
NamespacePassword	string	是	命名空间对应的密码。说明本值为 CreateNamespace 接口指定。	testpassword
RegionId	string	是	实例所在的地域 ID。	cn-hangzhou
FileName	string	是	文件名。注意文件建议带有文档类型后缀，如`.json`、`.md`或`.pdf`。如果不带后缀，将使用默认的非结构化加载器加载。图片文件必须带有文件后缀，当前支持的图片后缀：`bmp`、`jpg`、`jpeg`、`png`和`tiff`。图片文件支持上传压缩包，压缩包必须带有文件后缀，支持的压缩包格式：`tar`、`gz`和`zip`。	mydoc.txt
FileUrl	string	是	公网可访问的文档 URL 地址。说明建议使用 SDK 调用此接口，SDK 帮封装了 UploadDocumentAsyncAdvance 方法可直接上传本地文件。如果是图片压缩包地址，当前压缩包里的图片数目最多为 100 张。	https://xx/mydoc.txt
Metadata	object	否	元数据信息，需和创建文档库（CreateDocumentCollection）时指定的 Metadata 字段一致。
	any	否	元数据信息，需和创建文档库（CreateDocumentCollection）时指定的 Metadata 字段一致。	{"title":"mytitle","page":1}
ChunkSize	integer	否	处理大型数据的切分策略：数据拆分成较小的部分时每个块的大小。最大值 2048。	250
ChunkOverlap	integer	否	处理大型数据的切分策略：在分块处理时，连续的块之间重叠的数据量。最大值不能超过 ChunkSize。说明这是为了防止数据被截断而丢失上下文信息。例如，在处理一个长文本时，您可能希望确保两个连续的文本块有一定量的重叠文本，这样模型就可以更好地理解两个块之间的上下文关系。	50
Separators	array	否	处理大型数据的切分策略：分隔符。说明 Seprators 是影响切分效果的关键参数，且和 TextSplitterName 指定的切分器相关。一般情况下不许指定，服务端会按照 TextSplitterName 自动适配。
	string	否	分隔符。	。
DryRun	boolean	否	是否只做文档理解和切分，不做向量化和入库。默认为 false。说明当不确定文档切分效果时，可先设置此值为 true 查看切分效果进行调优。	false
ZhTitleEnhance	boolean	否	是否开启中文标题加强。说明文档理解时，通过增加标题判断，判断哪些文本为标题，并在 metadata 中进行标记，然后将文本与往上一级的标题进行拼合，实现文本信息的增强。	false
TextSplitterName	string	否	切分器名称。取值说明： ChineseRecursiveTextSplitter（默认值）：继承于 RecursiveCharacterTextSplitter，默认以`["\n\n","\n", "。\|！\|？","\.\s\|\!\s\|\?\s", "；\|;\s", "，\|,\s"]`作为分隔符，使用正则匹配，中文比 RecursiveCharacterTextSplitter 效果更好一些。 SpacyTextSplitter：默认以`["\n\n", "\n", " ", ""]`作为分隔符。可以支持`c++/go/java/js/php/proto/python/rst/ruby/rust/scala/swift/markdown/latex/html/sol/csharp`等多种代码语言的切分。 RecursiveCharacterTextSplitter：默认分隔符为`\n\n`，使用 Spacy 库的 en_core_web_sm 模型来分隔；对全英文文档支持较好。 MarkdownHeaderTextSplitter：针对 markdown 类型，使用 `[ ("#", "head1"), ("##", "head2"), ("###", "head3"), ("####", "head4") ]`来切分。	ChineseRecursiveTextSplitter
DocumentLoaderName	string	否	建议无需指定，会按照文件扩展名自动匹配加载器，支持的列表如下： UnstructuredHTMLLoader：`.html` UnstructuredMarkdownLoader：`.md` PyMuPDFLoader：`.pdf` PyPDFLoader：`.pdf` RapidOCRPDFLoader：`.pdf` JSONLoader：`.json` CSVLoader：`.csv` RapidOCRLoader：`.png`、.`jpg`、`.jpeg`或`.bmp` UnstructuredFileLoader：`.eml`、`.msg`、`.rst`、`.txt`、`.docx`、`.epub`、`.odt`、`.pptx`或`.tsv`	PyMuPDFLoader

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	返回信息。	success
Status	string	创建状态，取值说明： success：成功 fail：失败	success
JobId	string	任务 ID，用于后续查看任务状态或者取消任务。	231460f8-75dc-405e-a669-0c5204887e91

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "JobId": "231460f8-75dc-405e-a669-0c5204887e91"
}

错误码

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