调用CreateCollection API创建向量数据集-云原生数据仓库AnalyticDB-阿里云-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

创建向量数据集。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:CreateCollection

create

*Collection

acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	否	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的实例 ID。	gp-bp152460513z****
ManagerAccount	string	是	具有 rds_superuser 权限的管理账号名称。说明您可以调用 CreateAccount 接口创建账号。	testaccount
ManagerAccountPassword	string	是	管理账号密码。	testpassword
Namespace	string	否	命名空间。说明您可以通过 CreateNamespace 接口创建，通过 ListNamespaces 接口查看列表。	mynamespace
Collection	string	是	要创建的集合名。说明名称需符合 PostgreSQL 对象名限制。	document
Dimension	integer	否	向量维度。说明如果指定此值，会构建索引，且后续上传向量数据接口 UpsertCollectionData 的 Rows.Vector 长度需和此值一致。如果不指定此值，可以后续调用 CreateVectorIndex 构建索引。	1024
FullTextRetrievalFields	string	否	用于全文检索的字段，多个字段用英文逗号（,）分隔，且字段必须属于 Metadata 里定义的 key。	title,content
Metadata	string	是	向量数据的元信息，为 MAP 格式的 JSON 字符串。其中 key 代表字段名，value 代表数据类型。说明支持的数据类型数据类型列表详见：数据类型。其中 money 类型暂不支持。警告 id、vector、to_tsvector、source 字段为保留字段，禁止使用。	{"title":"text","content":"text","response":"int"}
Parser	string	否	用于全文检索的分词器，默认为 zh_cn。	zh_cn
RegionId	string	是	实例所在地域 ID。	cn-hangzhou
Metrics	string	否	向量构建索引时的方法。取值说明： l2：欧氏距离。 ip：点积（内积）距离。 cosine：余弦相似度。	cosine
HnswM	integer	否	HNSW 算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。说明取值范围： AnalyticDB PostgreSQL 6.0 版实例：1～1000。 AnalyticDB PostgreSQL 7.0 版实例：2～100，默认值 16。说明建议根据向量维度来设置：小于等于 384：16 大于 384 小于等于 768：32 大于 768 小于等于 1024：64 大于 1024：128	64
HnswEfConstruction	string	否	HNSW 算法构建索引时的候选集大小。取值需要>= 2*HNSW_M。说明取值范围： AnalyticDB PostgreSQL 6.0 版实例：40～4000。 AnalyticDB PostgreSQL 7.0 版实例：4～1000，默认值 64。	128
PqEnable	integer	否	索引是否开启 PQ(Product quantization)算法加速，数据量大于 50w 时建议开启。取值说明： 0：关闭。 1：开启（默认）。	1
ExternalStorage	integer	否	是否使用 mmap 构建 HNSW 索引，默认为 0。如果数据不需要删除，且对上传数据的速度性能有要求时，建议设置为 1。取值说明： 0：默认采用段页式存储构建索引，这种模式可以使用 PostgreSQL 中的 shared_buffer 做缓存，支持删除和更新等操作。 1：该索引会采用 mmap 构建索引，该模式不支持删除更新等操作。重要仅 6.0 版本支持参数 ExternalStorage。7.0 版本暂不支持。	0
WorkspaceId	string	否	多数据库实例组成的 Workspace 的 Id。此参数和 DBInstanceId 参数不能同时为空，当和 DBInstanceId 同时指定时以此参数为准。	gp-ws-*****
MetadataIndices	string	否	标量索引字段，多个字段用英文逗号（,）分隔，且字段必须属于 Metadata 里定义的 key。	title
SupportSparse	boolean	否	是否支持稀疏向量。默认值：false。	true
SparseVectorIndexConfig	object	否	稀疏向量索引配置。如果传入，则创建稀疏向量索引。
HnswM	integer	否	HNSW 算法中的最大邻居数。接口会根据向量维度自动设置此值，一般不需要手动设置。说明取值范围： AnalyticDB PostgreSQL 6.0 版实例：1～1000。 AnalyticDB PostgreSQL 7.0 版实例：2～100，默认值 16。说明建议根据向量维度来设置：小于等于 384：16 大于 384 小于等于 768：32 大于 768 小于等于 1024：64 大于 1024：128	64
HnswEfConstruction	integer	否	HNSW 算法构建索引时的候选集大小。取值范围：4～1000，默认值 64。说明仅 AnalyticDB PostgreSQL 7.0 版实例需要传该值，且取值需要>= 2*HNSW_M。	128
Algorithm	string	否	向量索引算法取值说明： hnswflat：不带量化压缩的 HNSW 索引（默认值） novam：不带量化压缩的图索引，适用于实时推荐等高性能场景	hnswflat
VectorIndexConfig	object	否	稠密向量索引配置。
Nlist	integer	否	Novad 列表数（分区数）。取值范围：[2, 1073741824]，默认值 256。	256
RabitqBits	integer	否	rabitq 压缩比特数。取值范围：[1, 8]，默认值 3。	3
Algorithm	string	否	向量索引算法取值说明： hnswflat：不带量化压缩的 HNSW 索引（默认值） novam：不带量化压缩的图索引，适用于实时推荐等高性能场景 novad：带 rabitq 量化的分区索引，适用于大规模低成本检索场景	hnswflat

说明

创建向量数据集成功后，您可参考 DescribeCollection 查看已创建的向量数据集。

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	接口返回详细信息。	create successfully
Status	string	创建状态，取值说明： success：成功。 fail：失败。	success

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "create successfully",
  "Status": "success"
}

错误码

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

变更历史

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