GetVectors - Object Storage Service - Alibaba Cloud Documentation Center

Panggil API GetVectors untuk mengambil data vektor tertentu berdasarkan kunci.

Izin

Akun Alibaba Cloud memiliki semua izin secara default. Namun, Pengguna RAM dan Peran RAM tidak memiliki izin secara default. Akun Alibaba Cloud atau administrator harus memberikan izin untuk operasi ini melalui RAM Policy atau Bucket Policy.

API	Action	Deskripsi
GetVectors	`oss:GetVectors`	Ambil data vektor.

Sintaksis Permintaan

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

{
   "indexName": "string",
   "keys": [string, string, string],
   "returnData": boolean,
   "returnMetadata": boolean
}

Header Permintaan

Operasi ini hanya menggunakan header permintaan umum. Untuk informasi selengkapnya, lihat Definisi Header HTTP Umum.

Parameter Permintaan

Nama	Tipe Data	Wajib	Nilai Contoh	Deskripsi
indexName	string	Ya	vectorindex1	Nama indeks.
keys	string array	Ya	["doc-001", "doc-002"]	Kunci primary dari vektor yang akan dikueri. Kunci primary duplikat diperbolehkan. Batasan: Jumlah kunci ∈ [1, 100] Panjang kunci ∈ [1, 1024]
returnData	Nilai Boolean	Tidak	false	Kembalikan data vektor. Nilai: true false (default)
returnMetadata	Nilai Boolean	Tidak	false	Kembalikan metadata. Nilai: true false (nilai default)

Header Respons

Operasi ini hanya mengembalikan header respons umum. Untuk informasi selengkapnya, lihat Header HTTP Umum.

Elemen Respons

Nama	Tipe Data	Nilai Contoh	Deskripsi
vectors	object array	-	Daftar vektor yang dikembalikan. Jika kunci primary yang dikueri tidak ada, tidak ada error yang dilaporkan, tetapi hasil untuk kunci tersebut tidak dikembalikan.
key	string	doc-001	Kunci primary vektor. Saat mengkueri berdasarkan kunci primary, jika vektor yang sesuai dengan kunci dalam permintaan tidak ada, permintaan tidak melaporkan error. Hasil yang dikembalikan hanya mencakup vektor yang ada dan tidak menyertakan data untuk kunci tersebut. Node induk: vectors
data	object	-	Data vektor (hanya dikembalikan jika returnData bernilai true). Node induk: vectors
metadata	object	-	Metadata (hanya dikembalikan jika returnMetadata bernilai true). Node induk: vectors

Contoh

Contoh permintaan

POST /?getVectors 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

{
   "indexName": "vectorindex1",
   "keys": ["doc-001", "doc-002"],
   "returnData": true,
   "returnMetadata": true
}

Contoh respons

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

SDK berikut mendukung operasi GetVectors:

Alat Baris Perintah ossutil

Untuk informasi selengkapnya tentang perintah ossutil untuk operasi GetVectors, lihat get-vectors.

Kode Error

Kode Error	Kode Status HTTP	Deskripsi
VectorIndexParameterInvalid	400	Parameter indeks vektor yang diberikan dalam permintaan tidak valid.
MalformedJson	400	Format JSON dalam badan permintaan tidak valid.
AccessDenied	403	Kemungkinan penyebab error ini adalah: Tidak ada informasi autentikasi pengguna yang disediakan saat menginisiasi permintaan. Tidak memiliki izin operasi.
NoSuchVectorIndex	404	Indeks vektor yang ditentukan tidak ada.
QpsLimitExceeded	503	Batas QPS terlampaui (permintaan dibatasi laju).