全部产品
Search

搜索本产品

    云原生数据仓库AnalyticDB：UpsertCollectionDataAsync - 异步上传向量数据

    文档中心

    云原生数据仓库AnalyticDB：UpsertCollectionDataAsync - 异步上传向量数据

    更新时间：Oct 22, 2024

    使用本地文件或公网可免密访问的文件链接异步上传向量数据，最大支持200MB。

    接口说明

    此接口为UpsertCollectionData对应的异步接口。UpsertCollectionData接口的请求最大只支持 10MB，此接口最大支持 200MB。

    说明 相关接口
  • 通过 GetUpsertCollectionDataJob 接口查看上传进度和结果。
  • 通过 CancelUpsertCollectionDataJob 接口取消上传任务。
    •

    注意 对于同一个 Collection 目前只允许串行上传数据任务，不允许并发上传。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    实例所在 Region ID。

    		cn-hangzhou
    DBInstanceIdstring否

    实例 ID。

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

    命名空间，默认为 public。

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

    集合名。

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

    命名空间对应的密码。

    说明 本值为 CreateNamespace 接口指定。
    		testpassword
    FileUrlstring是

    公网可访问的向量数据文件 URL 地址。

    说明
  • 文件内容格式为 JSONL，即每一行是一个特定格式的 JSON 数据，代表一组向量数据。
  • 单行的数据结构为{String Id; Map<String, Object> Metadata; List<Double> Vector}, 如{"Id":"myid", "Metadata": {"my_meta_key": "my_meta_value"}, "Vector": [1.234, -0.123]}。
  • 建议使用 SDK 调用此接口，SDK 帮封装了 UpsertCollectionDataAsyncAdvance 方法可直接上传本地文件作为数据源。
    •
    		https://xx/vectors.jsonl
    WorkspaceIdstring否

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

    		gp-ws-*****

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    返回信息。

    		success
    Statusstring

    API 执行状态，取值如下：

    • success：执行成功。
    • fail：执行失败。
    		success
    JobIdstring

    任务 ID，用于后续查看任务状态或者取消任务。

    		231460f8-75dc-405e-a669-0c5204887e91

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "JobId": "231460f8-75dc-405e-a669-0c5204887e91"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-08-04OpenAPI 入参发生变更查看变更详情