ModifyCollection - 修改向量数据集

更新时间:
重要

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

更新向量数据集

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
NamespacePasswordstring

命名空间对应的密码。

testpassword
Namespacestring

命名空间,默认为 public。

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

集合名。

说明 您可以通过 ListCollections 接口查看列表。
document
Metadatastring

向量 metadata 新增和修改操作的元信息,为 JSON 字符串,其中 JSON 字符串的格式如示例所示。

通过指定该参数可以实现增加新的 metadata 定义,也可对已有 metadata 的定义执行重命名和隐式数据类型转换操作。

具体来说

当指定 operations[*].operator = add 时,为增加新 metadata 定义的操作,此时 operations[*].newMetaName 代表新 metadata 定义的名称, operations[*].newMetaType 代表新 metadata 定义的数据类型

当指定 operations[*].operator = replace 时,为修改已有 metadata 定义的操作,此时 operations[*].oldMetaName 代表当前 metadata 定义的名称, operations[*].newMetaName 代表 metadata 定义重命名后的名称, operations[*].newMetaType 代表 metadata 定义新的数据类型。如果仅需要重命名,则无需指定 operations[*].newMetaType 字段,如果仅需隐式数据类型转换,则无需指定 operations[*].newMetaName 字段

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

    {"operations":[ {"operator":"add","newMetaType":"int","newMetaName":"ext1"}, {"operator":"replace","oldMetaName":"ext2","newMetaName":"ext3"}, {"operator":"replace","newMetaType":"bigint","oldMetaName":"ext4"}, {"operator":"replace","newMetaType":"int","oldMetaName":"ext5","newMetaName":"ext6"} ]}
    RegionIdstring

    实例所在的地域 ID。

    cn-hangzhou
    WorkspaceIdstring

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

    gp-ws-*****

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    Messagestring

    返回信息。

    Successful
    Metadatastring

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

    说明 支持的数据类型
  • 数据类型列表详见:数据类型
  • 其中 money 类型暂不支持。
  • {"title":"text","content":"text","response":"int"}
    RequestIdstring

    请求 ID。

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

    API 执行状态,取值如下:

    • false:执行失败。
    • true:执行成功。
    success

    示例

    正常返回示例

    JSON格式

    {
      "Message": "Successful",
      "Metadata": {
        "title": "text",
        "content": "text",
        "response": "int"
      },
      "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
      "Status": "success"
    }

    错误码

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