Object Storage Service:ListVectors

権限

デフォルトでは、Alibaba Cloud アカウントにはすべてのリソースにアクセスするためのフル権限があります。RAM ユーザーおよび RAM ロールには、デフォルトでは権限がありません。Alibaba Cloud アカウントの所有者または管理者が、RAM ポリシーまたはバケットポリシーを使用して権限を付与する必要があります。

リクエスト構文

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

{
   "indexName": "string",
   "maxResults": int,
   "nextToken": "string",
   "returnData": boolean,
   "returnMetadata": boolean,
   "segmentCount": int,
   "segmentIndex": int,
   "filter": {
       "$and": [{
           "type": {
               "$in": ["comedy", "documentary"]
           }
       }, {
           "year": {
               "$eq": "2020"
           }
       }]
    }
}

リクエストヘッダー

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

リクエストパラメーター

レスポンスヘッダー

この操作では、共通のレスポンスヘッダーのみを使用します。詳細については、「Common HTTP headers」をご参照ください。

レスポンス要素

例

リクエスト例

POST /?listVectors HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.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": "vectorindex1",
   "maxResults": 10,
   "returnData": true,
   "returnMetadata": true
}

レスポンス例

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

{
   "nextToken": "CAESCG15aC2xxxxx",
   "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"
         }
      },
      { 
         "data": {
            "float32": [0.2, 0.3, 0.4, 0.5, 0.6]
         },
         "key": "doc-002",
         "metadata": {
             "category": ["science"],
             "title": "Advanced Vector Operations"
         }
      }
   ]
}

SDK

ListVectors API は、次の SDK で使用できます：

• List vectors (Python SDK V2)

• List vectors (Go SDK V2)

ossutil CLI

対応する ossutil コマンドについては、「list-vectors」をご参照ください。

エラーコード