DescribeDocument_云原生数据仓库 AnalyticDB PostgreSQL版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为3000/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
gpdb:DescribeDocument
Create
Document
acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。展开详情

示例值:gp-xxxxxxxxx参考取值来源:
    UpgradeDBInstance
    CreateDBInstance
    UpdateDBInstancePlan
    DescribeDBInstances
    PauseInstance
    ModifyDBInstancePayType
    ResumeInstance
    UploadDocumentAsync
    DownloadDiagnosisRecords
    UnloadSampleData
Namespacestring

命名空间,默认为 public。展开详情

示例值:mynamespace参考取值来源:
    ListNamespaces
    CreateNamespace
NamespacePasswordstring

命名空间对应的密码。展开详情

示例值:testpassword
Collectionstring

文档库名称。展开详情

示例值:document参考取值来源:
    ListCollections
    CreateCollection
    UpsertCollectionData
RegionIdstring

实例所在 Region ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
FileNamestring

文档名。展开详情

示例值:music.txt

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

接口返回详细信息。

示例值:success
Statusstring

API 执行状态,取值如下:展开详情

示例值:success
FileNamestring

文件名。

示例值:music.txt
FileExtstring

文件扩展名。

示例值:txt
FileVersioninteger<int32>

文档版本。每次更新上传同一文档时,此值会+1。

示例值:1
FileMtimestring

文档最新修改时间。

示例值:2023-11-01 10:01:01.123456
Sourcestring

文档来源。

示例值:OSS
DocumentLoaderstring

文档加载器名称。

示例值:RapidOCRPDFLoader
TextSplitterstring

文档切分器名称。

示例值:ChineseRecursiveTextSplitter
FileSizeinteger<int64>

文件大小,单位为字节。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:10000
FileMd5string

文件 MD5 值。

示例值:b8078c9591413550f8963e37e24abcea
DocsCountinteger<int32>

文档被切分的数量。

示例值:100
FileUrlstring

文档的下载地址,有效期为 2h。

示例值:http://oss.xxx/music.txt
PlainChunkFileUrlstring

被切分后的纯文本(不带 Metadata)下载地址,每行是一个 chunk,有效期为 2h。

示例值:http://oss.xxx/music_plain_chunk.txt
ChunkFileUrlstring

切分后的文件链接,有效期为 2h。文件格式为 JSONL,每一行的格式为{"page_content":"*****", "metadata": {"**":"***","**":"***"}

示例值:http://oss.xxx/music_chunk.jsonl

返回示例

变更历史

变更时间变更内容概要操作
2024-07-03
变更返回参数

相关示例

查看文档详细信息
2023-11-30