使用ListVectors列舉向量索引內的全部向量-Object Storage Service-阿里雲 - Object Storage Service

許可權說明

阿里雲帳號預設擁有全部許可權。阿里雲帳號下的RAM使用者或RAM角色預設沒有任何許可權，需要阿里雲帳號或帳號管理員通過RAM Policy概述或Bucket Policy授予操作許可權。

API	Action	說明
ListVectors	`oss:ListVectors`	列舉向量資料。

請求文法

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"
           }
       }]
    }
}

要求標頭

此介面僅涉及公用要求標頭。更多資訊，請參見公用HTTP頭定義。

請求參數

名稱	資料類型	是否必選	樣本值	描述
indexName	字串	是	vectorindex1	索引名稱。
maxResults	數值	否	500	每次返回的最大結果數，預設值500，最大為1000。
nextToken	字串	否	CAESCG15aC1xxxxx	查詢憑證（Token），取值為上一次API調用返回的nextToken參數值。第一次調用此介面時，設定為空白。參數長度為1~2048位元組。
returnData	布爾值	否	false	是否返迴向量資料。取值： true false（預設值）
returnMetadata	布爾值	否	false	是否返回中繼資料。取值： true false（預設值）
segmentCount	數值	否	1	並行ListVectors時，使用者可指定並行度，最大為16。串列時，設定為1。
segmentIndex	數值	否	0	並行ListVectors時，分段的index必須小於segmentCount。
filter	容器	否	不適用	通過中繼資料對查詢資料進行過濾。配置可過濾中繼資料時：單次過濾指令中可過濾中繼資料的累計長度不超過 20 KB；單次過濾指令中可過濾中繼資料項數量不超過 1024 個；過濾條件嵌套層級最多支援 8 層。

filter操作符

操作符	支援類型	描述
`$eq`	String	精確匹配（用於單個值）。當與數群組類型的中繼資料進行比較時，如果輸入值能匹配數組中的任意一個元素，則返回true。
`$ne`	String	不等於
`$gt`	Number	大於
`$gte`	Number	大於等於
`$lt`	Number	小於
`$lte`	Number	小於等於
`$in`	String array	匹配數組中的任意一個值（類似於SQL的`IN`操作）
`$nin`	String array	不匹配數組中的任何一個值（類似於SQL的`NOT IN`操作）
`$exists`	Boolean	檢查中繼資料的key是否存在
`$and`	Non-empty array of filters	多條件判斷與（AND）
`$or`	Non-empty array of filters	多條件判斷或（OR）
`$nor`	Non-empty array of filters	多條件判斷非（NOR）

回應標頭

此介面僅涉及公用回應標頭。更多資訊，請參見公用HTTP頭定義。

響應元素

名稱	資料類型	樣本值	說明
nextToken	字串	CAESCG15aC2xxxxx	下一頁查詢憑證（Token）。如果為空白，表示已列舉完成。
vectors	對象數組	不適用	返迴向量列表。
key	字串	doc-001	向量主鍵。父節點：vectors
data	對象	不適用	向量資料（僅當returnData為true時返回）。父節點：vectors
metadata	對象	不適用	中繼資料（僅當returnMetadata為true時返回）。父節點：vectors

樣本

請求樣本

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介面所對應的各語言SDK如下：

命令列工具ossutil

ListVectors介面所對應的ossutil命令，請參見list-vectors。

錯誤碼

錯誤碼	HTTP狀態代碼	描述
VectorIndexParameterInvalid	400	請求中提供的向量索引參數不合法。
MalformedJson	400	請求體中的 JSON 格式不符合規範。
AccessDenied	403	返回該錯誤的可能原因如下：發起請求時沒有傳入使用者驗證資訊。沒有操作許可權。
NoSuchVectorIndex	404	指定的向量索引不存在。
QpsLimitExceeded	503	QPS 限流（請求速率受限）。