GetVectors

許可權說明

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

API	Action	說明
GetVectors	`oss:GetVectors`	擷取向量資料。

請求文法

POST /?getVectors 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",
   "keys": [string, string, string],
   "returnData": boolean,
   "returnMetadata": boolean
}

要求標頭

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

請求參數

名稱	資料類型	是否必選	樣本值	描述
indexName	字串	是	vectorindex1	索引名稱。
keys	字串數組	是	["doc-001", "doc-002"]	要查詢的向量的主鍵，允許出現重複主鍵。限制： key數量 ∈ [1, 100] key長度 ∈ [1, 1024]
returnData	布爾值	否	false	是否返迴向量資料。取值： true false（預設值）
returnMetadata	布爾值	否	false	是否返回中繼資料。取值： true false（預設值）

回應標頭

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

響應元素

名稱	資料類型	樣本值	說明
vectors	對象數組	-	返迴向量列表。如果查詢的主鍵不存在，無報錯但不返回當前key結果。
key	字串	doc-001	向量主鍵。按主鍵查詢時，若請求中的某個 key 對應的向量不存在，請求不會報錯；返回結果僅包含已存在的向量，不包含該 key 的資料。父節點：vectors
data	對象	-	向量資料（僅當returnData為true時返回）。父節點：vectors
metadata	對象	-	中繼資料（僅當returnMetadata為true時返回）。父節點：vectors

樣本

請求樣本

POST /?getVectors 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",
   "keys": ["doc-001", "doc-002"],
   "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

{
   "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

GetVectors介面所對應的各語言SDK如下：

命令列工具ossutil

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

錯誤碼

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