创建向量集的索引。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| gpdb:CreateVectorIndex | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。
| gp-xxxxxxxxx |
| Collection | string | 是 | 集合名。 说明
您可以 ListCollections 接口查看列表。
| document |
| Dimension | integer | 是 | 向量维度。 说明
此值需和上传向量 UpsertCollectionData 接口的向量数据 Rows. Vector 长度一致。
| 1024 |
| ManagerAccount | string | 是 | 具有 rds_superuser 权限的管理账户名称。 说明
您可以通过控制台->账号管理来创建账号，或者通过 CreateAccount 接口创建。
| testaccount |
| ManagerAccountPassword | string | 是 | 管理账户密码。 | testpassword |
| Metrics | string | 否 | 向量构建索引时的方法。取值说明：
| cosine |
| Namespace | string | 否 | 命名空间，默认为 public。 说明
您可以通过 ListNamespaces 接口查看列表。
| mynamespace |
| RegionId | string | 是 | 实例所在的地域 ID。 | cn-hangzhou |
| PqEnable | integer | 否 | 索引是否开启 PQ（Product quantization）算法加速，数据量大于 50w 时建议开启。取值说明：
| 1 |
| HnswM | integer | 否 | HNSW 算法中的最大邻居数，范围为 1～1000。接口会根据向量维度自动设置此值，一般不需要手动设置。 说明
建议根据向量维度来设置：
| 64 |
| ExternalStorage | integer | 否 | 是否使用 mmap 构建 HNSW 索引，默认为 0。如果数据不需要删除，且对上传数据的速度性能有要求时，建议设置为 1。 说明
| 0 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "Successful",
"Status": "success"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-09 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-11-07 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2023-08-08 | OpenAPI 入参发生变更 | 查看变更详情 |