PutVectors

调用PutVectors接口向索引中写入向量数据。

注意事项

  • 单张向量 Index 表最多存储 5000 万行向量数据。

  • PutVectors接口单批次最大写入 500 条。

权限说明

阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限,需要阿里云账号或账号管理员通过RAM PolicyBucket Policy授予操作权限。

API

Action

说明

PutVectors

oss:PutVectors

写入向量数据。

请求语法

POST /?putVectors HTTP/1.1
Host: exampebucket-123***456.cn-hangzhou.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
Content-type: application/json

{
   "indexName": "string",
   "vectors": [ 
      { 
         "data": {
            "float32":[float]
         },
         "key": "string",
         "metadata": {
             "key1": ["value1", "value2"],
             "key2": "value2"
         }
      }
   ]
}

请求头

此接口仅涉及公共请求头。更多信息,请参见公共HTTP头定义

请求参数

名称

数据类型

是否必选

示例值

描述

indexName

字符串

my-vector-index

索引名称。

vectors

容器

-

写入的向量数组,总大小1KB~500KB之间

key

字符串

doc-001

写入向量主键,标识向量唯一值。限制:

  • key相同则覆盖,但若在同一批次中key有重复则全部异常

  • key单值长度在1~1024字符之间

  • key需为utf8格式。

父节点:vectors

data

容器

-

向量内容。

父节点:vectors

float32

数值数组

[0.1, 0.2, 0.3]

向量数据,数据类型为float32。向量维度必须与索引定义的维度一致。使用余弦距离度量时,不允许出现零向量。

父节点:data

metadata

容器

-

元数据。限制:

  • 总大小 <= 40KB

  • 可过滤metadata限制:

    • 长度 ∈ [0, 10]

    • 可过滤部分大小 <= 2KB

    • 支持类型string。

  • 配置可过滤元数据时:

    • 单次过滤指令中可过滤元数据的累计长度不超过 64 KB;

    • 单次过滤指令中可过滤元数据项数量不超过 1024 个;

    • 过滤条件嵌套层级最多支持 8 层;

    • 允许过滤条件为空。

父节点:vectors

响应头

此接口仅涉及公共响应头。更多信息,请参见公共HTTP头定义

示例

请求示例

POST /?putVectors HTTP/1.1
Host: exampebucket-123***456.cn-hangzhou.oss-vectors.aliyuncs.com
Date: Thu, 17 Apr 2025 01:33:47 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218
Content-type: application/json

{
   "indexName": "my-vector-index",
   "vectors": [ 
      { 
         "data": {
            "float32": [0.1, 0.2, 0.3, 0.4, 0.5]
         },
         "key": "doc-001",
         "metadata": {
             "category": ["technology", "ai"],
             "title": "Introduction to Vector Search"
         }
      }
   ]
}

返回示例

HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Thu, 17 Apr 2025 01:33:47 GMT
Connection: keep-alive
Server: AliyunOSS