CreateCollection - 创建向量数据集

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

创建向量数据集。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:CreateCollectioncreate
  • Collection
    acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的实例 ID。
gp-bp152460513z****
ManagerAccountstring

具有 rds_superuser 权限的管理账号名称。

说明 您可以调用 CreateAccount 接口创建账号。
testaccount
ManagerAccountPasswordstring

管理账号密码。

testpassword
Namespacestring

命名空间。

说明 您可以通过 CreateNamespace 接口创建,通过 ListNamespaces 接口查看列表。
mynamespace
Collectionstring

要创建的集合名。

说明 名称需符合 PostgreSQL 对象名限制。
document
Dimensionlong

向量维度。

说明 如果指定此值,会构建索引,且后续上传向量数据接口 UpsertCollectionData 的 Rows.Vector 长度需和此值一致。如果不指定此值,可以后续调用 CreateVectorIndex 构建索引。
1024
FullTextRetrievalFieldsstring

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

title,content
Metadatastring

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

说明 支持的数据类型
  • 数据类型列表详见:数据类型
  • 其中 money 类型暂不支持。
  • 警告 id、vector、to_tsvector、source 字段为保留字段,禁止使用。

    {"title":"text","content":"text","response":"int"}
    Parserstring

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

    zh_cn
    RegionIdstring

    实例所在地域 ID。

    cn-hangzhou
    Metricsstring

    向量构建索引时的方法。取值说明:

    • l2:欧氏距离。
    • ip:点积(内积)距离。
    • cosine:余弦相似度。
    cosine
    HnswMinteger

    HNSW 算法中的最大邻居数,范围为 1~1000。接口会根据向量维度自动设置此值,一般不需要手动设置。

    说明 建议根据向量维度来设置:
  • 小于等于 384:16
  • 大于 384 小于等于 768:32
  • 大于 768 小于等于 1024:64
  • 大于 1024:128
  • 64
    PqEnableinteger

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

    • 0:关闭。
    • 1:开启(默认)。
    1
    ExternalStorageinteger

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

    说明
  • 为 0 时,默认会采用段页式存储构建索引,这种模式可以使用 PostgreSQL 中的 shared_buffer 做缓存,支持删除和更新等操作。
  • 为 1 时,该索引会采用 mmap 构建索引,该模式不支持删除更新等操作。
  • 0
    WorkspaceIdstring

    多数据库实例组成的 Workspace 的 Id。此参数和 DBInstanceId 参数不能同时为空,当和 DBInstanceId 同时指定时以此参数为准。

    gp-ws-*****

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Messagestring

    接口返回详细信息。

    create successfully
    Statusstring

    创建状态,取值说明:

    • success:成功。
    • fail:失败。
    success

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-08-04OpenAPI 入参发生变更查看变更详情
    2024-01-09OpenAPI 入参发生变更查看变更详情
    2023-11-07API 内部配置变更,不影响调用查看变更详情
    2023-08-08OpenAPI 入参发生变更查看变更详情