Object Storage Service:PutVectorIndex

注意事項

• 1 つのベクターバケットには、最大 100 個のベクターインデックスを含めることができます。 このクォータを増やすには、テクニカルサポートまでご連絡ください。

• 1 秒あたり最大 5 件の PutVectorIndex リクエストがサポートされます。

権限

デフォルトでは、Alibaba Cloud アカウント (root ユーザー) はすべての権限を持ちますが、Resource Access Management (RAM) ユーザーと RAM ロールには権限がありません。 Alibaba Cloud アカウント (root ユーザー) または管理者は、RAM ポリシーまたはバケットポリシーを通じて権限を付与する必要があります。

リクエスト構文

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

{
   "dataType": "string",
   "dimension": int,
   "distanceMetric": "string",
   "indexName": "string",
   "metadata": { 
      "nonFilterableMetadataKeys": [string, string]
   }
}

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみを使用します。 詳細については、「共通リクエストヘッダー」をご参照ください。

リクエストパラメーター

応答ヘッダー

この操作では、共通の応答ヘッダーのみを使用します。 詳細については、「共通応答ヘッダー」をご参照ください。

例

リクエスト例

POST /?putVectorIndex HTTP/1.1
Host: examplebucket-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

{
   "dataType": "float32",
   "dimension": 1024,
   "distanceMetric": "euclidean",
   "indexName": "vectorindex1",
   "metadata": { 
      "nonFilterableMetadataKeys": ["category", "timestamp"]
   }
}

レスポンス例

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

SDK

PutVectorIndex API は、次のソフトウェア開発キット (SDK) でサポートされています：

• ベクターインデックスの作成 (Python SDK V2)

• ベクターインデックスの作成 (Go SDK V2)

ossutil コマンドラインツール

PutVectorIndex API に対応する ossutil コマンドについては、「put-vector-bucket」をご参照ください。

エラーコード