UpsertCollectionData - 上传向量数据

上传向量数据到指定的向量集中。

接口说明

注意 SDK 于 2023-11-8 日升级,从最大 512KB 数据请求量升级到 10MB。 请使用最新版 SDK 或不低于此版本:
  • Java:1.2.1
  • Go:v3.3.1
  • Python:3.3.1
  • 调试

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

    授权信息

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

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

    请求参数

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

    实例 ID。

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

    集合名。

    说明 可以通过 CreateCollection 创建,并通过 ListCollections 查看列表。
    document
    Namespacestring

    命名空间,用于租户隔离,默认为 public。

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

    命名空间对应的密码。

    testpassword
    Rowsarray<object>

    向量数据列表。

    object

    单条向量数据信息。

    Idstring

    此条向量数据的唯一 ID。

    说明 如果为空,则由数据库 uuidgen 自动生成。如果不为空,且和数据库里已有的 ID 冲突,则会使用 API 的数据更新数据库里的值。
    854c6949-411c-4b47-aec4-e324735f9574
    Metadataobject

    此条向量数据对应的元信息。其中 key 需和 CreateCollection 接口定义的 Metadata 的 key 一致。

    string

    向量元数据。

    {"title":"test title", "content": "test content"}
    Vectorarray

    向量数据列表,长度和 CreateCollection 接口的维度一致。

    double

    向量数据。

    [1.0123,-0.1234]
    RegionIdstring

    实例所在的地域 ID。

    cn-hangzhou
    WorkspaceIdstring

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

    gp-ws-*****

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    信息

    success
    Statusstring

    上传状态,取值说明:

    • success:成功
    • fail:失败
    success

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

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