GetVectors - Object Storage Service - Alibaba Cloud Documentation Center

Mengambil data vektor yang ditentukan berdasarkan kunci.

Permissions

Akun Alibaba Cloud memiliki semua izin secara default. Pengguna RAM atau Peran RAM tidak memiliki izin apa pun secara default. Akun Alibaba Cloud atau administrator harus memberikan izin melalui RAM policy atau bucket policy.

API	Action	Description
GetVectors	`oss:GetVectors`	Mendapatkan data vektor.

Sintaks Permintaan

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
}

Request headers

Operasi ini hanya menggunakan header permintaan umum. Untuk informasi selengkapnya, lihat Common HTTP headers.

Parameter Permintaan

Name	Data type	Required	Example	Description
indexName	String	Yes	vectorindex1	Nama indeks.
keys	Array of strings	Yes	["doc-001", "doc-002"]	Kunci primary dari vektor yang akan dikueri. Kunci primary duplikat diperbolehkan. Batasan: Jumlah kunci: 1 hingga 100. Panjang kunci: 1 hingga 1024.
returnData	Boolean	No	false	Menentukan apakah data vektor akan dikembalikan. Nilai yang valid: true false (default)
returnMetadata	Boolean	No	false	Menentukan apakah metadata akan dikembalikan. Nilai yang valid: true false (default)

Response headers

Operasi ini hanya menggunakan header respons umum. Untuk informasi selengkapnya, lihat Common HTTP headers.

Elemen Respons

Name	Data type	Example	Description
vectors	Array of objects	-	Vektor yang dikembalikan. Jika kunci primary yang dikueri tidak ada, tidak ada error yang dilaporkan dan hasil untuk kunci tersebut dihilangkan.
key	String	doc-001	Kunci primary dari vektor. Jika kunci yang diminta tidak sesuai dengan vektor yang ada, tidak ada error yang dilaporkan dan respons menghilangkan kunci tersebut. Parent node: vectors
data	Object	-	Data vektor. Hanya dikembalikan jika returnData diatur ke true. Parent node: vectors
metadata	Object	-	Metadata. Hanya dikembalikan jika returnMetadata diatur ke true. Parent node: vectors

Contoh

Standard Mode

Permintaan contoh

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
}

Respons contoh

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

Fusion Mode

Catatan

Untuk indeks mode Fusion, data menggunakan nama field vektor yang ditentukan dalam skema saat indeks dibuat, bukan nama field vektor tetap float32 yang digunakan dalam Standard mode, dan dapat mengembalikan beberapa field vektor.

Permintaan contoh

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
}

Respons contoh

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": {
            "vector_field_name_1": [0.1, 0.2, 0.3, 0.4, 0.5]
         },
         "key": "doc-001",
         "metadata": {
             "category": ["technology", "ai"],
             "title": "Introduction to Vector Search"
         }
      },
      { 
         "data": {
            "vector_field_name_1": [0.1, 0.2, 0.3, 0.4, 0.5],
            "vector_field_name_2": [0.2, 0.3, 0.4, 0.5, 0.6]
         },
         "key": "doc-002",
         "metadata": {
             "category": ["science"],
             "title": "Advanced Vector Operations"
         }
      }
   ]
}

SDK

SDK berikut mendukung operasi GetVectors:

ossutil command-line interface

Untuk perintah ossutil yang sesuai dengan operasi GetVectors, lihat get-vectors.

Kode Error

Error code	HTTP status code	Description
VectorIndexParameterInvalid	400	Parameter indeks vektor tidak valid.
MalformedJson	400	JSON dalam badan permintaan tidak sesuai format.
AccessDenied	403	Kemungkinan penyebab error ini: Permintaan tidak menyertakan informasi otentikasi pengguna. Anda tidak memiliki izin yang diperlukan untuk operasi ini.
NoSuchVectorIndex	404	Indeks vektor yang ditentukan tidak ada.
QpsLimitExceeded	503	Permintaan dibatasi karena batas QPS terlampaui.