CreateDocumentCollection_云原生数据仓库 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:CreateDocumentCollection
Create
Collection
acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。展开详情

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

具有 rds_superuser 权限的管理账号名称。展开详情

示例值:testaccount
ManagerAccountPasswordstring

管理账号密码。

示例值:testpassword
Namespacestring

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

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

要创建的文档库名称。展开详情

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

实例所在地域 ID。

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

向量化算法。默认值:text-embedding-v3。展开详情

示例值:text-embedding-v1枚举值:
Dimensioninteger<int32>

向量维度。默认值是向量化算法支持的维度。

示例值:1024
FullTextRetrievalFieldsstring

用于全文检索的字段,多个字段用英文逗号(,)分隔,且字段必须属于 Metadata 里定义的 key。

示例值:title,page
Metadatastring

向量数据的元信息,为 MAP 格式的 JSON 字符串。其中 key 代表字段名,value 代表数据类型。展开详情

示例值:{"title":"text","page":"int"}
Parserstring

用于全文检索的分词器,默认为 zh_cn。

示例值:zh_cn
Metricsstring

向量构建索引时的方法展开详情

示例值:cosine
HnswMinteger<int32>

HNSW 算法中的最大邻居数。接口会根据向量维度自动设置此值,一般不需要手动设置。展开详情

示例值:64枚举值:取值 <= 1000
HnswEfConstructionstring

HNSW 算法构建索引时的候选集大小。取值范围:4~1000,默认值 64。展开详情

示例值:128
PqEnableinteger<int32>

索引是否开启 PQ(Product quantization)算法加速,数据量大于 50w 时建议开启。取值说明:展开详情

示例值:1枚举值:
ExternalStorageinteger<int32>

是否使用 mmap 构建 HNSW 索引,默认为 0。如果数据不需要删除,且对上传数据的速度性能有要求时,建议设置为 1。展开详情

示例值:0枚举值:01
MetadataIndicesstring

标量索引字段,多个字段用英文逗号(,)分隔,且字段必须属于 Metadata 里定义的 key。

示例值:title

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

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

返回信息。

示例值:Successful
Statusstring

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

示例值:successs

返回示例

变更历史

变更时间变更内容概要操作
2025-03-06
变更请求参数EmbeddingModel
新增请求参数Dimension
2025-01-14
新增请求参数HnswEfConstruction
2024-12-12
新增请求参数MetadataIndices
2024-01-09
变更请求参数EmbeddingModel
变更请求参数HnswM
变更请求参数PqEnable
新增请求参数ExternalStorage

相关示例

创建文档库
2023-11-30