Panggil operasi GetVectors untuk mengambil data vektor berdasarkan kunci tertentu.
Permissions
Akun Alibaba Cloud memiliki semua izin secara default. Secara default, pengguna Resource Access Management (RAM) atau Peran RAM di bawah akun Alibaba Cloud tidak memiliki izin apa pun. Akun Alibaba Cloud atau administrator harus memberikan izin untuk operasi ini melalui RAM policy atau bucket policy.
|
API |
Action |
Description |
|
GetVectors |
|
Mengambil 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 yang duplikat diperbolehkan. Batasan:
|
|
returnData |
Boolean |
No |
false |
Menentukan apakah data vektor akan dikembalikan. Nilai yang valid:
|
|
returnMetadata |
Boolean |
No |
false |
Menentukan apakah metadata akan dikembalikan. Nilai yang valid:
|
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 |
- |
Daftar vektor yang dikembalikan. Jika kunci primary yang Anda kueri tidak ada, tidak ada error yang dilaporkan dan hasil untuk kunci tersebut tidak dikembalikan. |
|
key |
String |
doc-001 |
Kunci primary dari vektor. Jika kunci yang diminta tidak sesuai dengan vektor yang ada, tidak ada error yang dilaporkan. Respons hanya mencakup data untuk vektor yang ada. Parent node: vectors |
|
data |
Object |
- |
Data vektor. Parameter ini hanya dikembalikan ketika returnData diatur ke true. Parent node: vectors |
|
metadata |
Object |
- |
Metadata. Parameter ini hanya dikembalikan ketika returnMetadata diatur ke true. Parent node: vectors |
Contoh
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"
}
}
]
}
SDK
SDK berikut mendukung operasi GetVectors:
ossutil command-line interface
Untuk informasi tentang perintah ossutil yang sesuai dengan operasi GetVectors, lihat get-vectors.
Kode error
|
Error code |
HTTP status code |
Description |
|
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:
|
|
NoSuchVectorIndex |
404 |
Indeks vektor yang ditentukan tidak ada. |
|
QpsLimitExceeded |
503 |
Pembatasan laju permintaan. |