ListVectors - Object Storage Service

API ListVectors mencantumkan semua data vektor dalam indeks vektor.

Izin

Akun Alibaba Cloud memiliki semua izin secara default. Pengguna Manajemen Akses Sumber Daya (RAM) atau Peran RAM di bawah Akun Alibaba Cloud tidak memiliki izin secara default. Administrator harus memberikan izin operasi melalui Kebijakan RAM atau kebijakan bucket.

API	Action	Deskripsi
ListVectors	`oss:ListVectors`	Mencantumkan data vektor.

Sintaks permintaan

POST /?listVectors HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou.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
}

Header permintaan

API ini hanya menggunakan header permintaan umum. Untuk informasi lebih lanjut, lihat Header HTTP Umum.

Parameter permintaan

Nama	Tipe data	Diperlukan	Contoh	Deskripsi
indexName	string	Ya	vectorindex1	Nama indeks.
maxResults	Angka	Tidak	500	Jumlah maksimum hasil yang dikembalikan per permintaan. Nilai default adalah 500. Nilai maksimum adalah 1.000.
nextToken	string	Tidak	CAESCG15aC-xxxxx	Token kueri. Atur parameter ini ke nilai nextToken yang dikembalikan dari pemanggilan API sebelumnya. Untuk pemanggilan pertama, biarkan parameter ini kosong. Parameter ini dapat berukuran 1 hingga 2.048 byte.
returnData	Boolean	Tidak	false	Menentukan apakah akan mengembalikan data vektor. Nilai valid: true false (default)
returnMetadata	Boolean	Tidak	false	Menentukan apakah akan mengembalikan metadata. Nilai valid: true false (default)
segmentCount	Angka	Tidak	1	Untuk panggilan ListVectors paralel, menentukan tingkat paralelisme. Nilai maksimum adalah 16. Untuk panggilan serial, atur ini ke 1.
segmentIndex	Angka	Tidak	0	Untuk panggilan ListVectors paralel, indeks segmen harus kurang dari segmentCount.

Header respons

API ini hanya menggunakan header respons umum. Untuk informasi lebih lanjut, lihat Header HTTP Umum.

Elemen respons

Nama	Tipe data	Contoh	Deskripsi
nextToken	string	CAESCG15aC2xxxxx	Token untuk halaman hasil berikutnya. Jika parameter ini kosong, semua hasil telah dicantumkan.
vectors	Array objek	N/A	Daftar vektor yang dikembalikan.
key	string	doc-001	Kunci utama vektor. Node induk: vectors
data	objek	N/A	Data vektor. Ini hanya dikembalikan ketika returnData bernilai true. Node induk: vectors
metadata	objek	N/A	Metadata. Ini hanya dikembalikan ketika returnMetadata bernilai true. Node induk: vectors

Contoh

Permintaan Sampel

POST /?listVectors 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",
   "maxResults": 10,
   "returnData": true,
   "returnMetadata": true
}

Respons Sampel

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": "CAESCG15aC2-xxxxx",
   "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"
         }
      }
   ]
}

Kode kesalahan

Kode kesalahan	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	Penyebab potensial untuk kesalahan ini: Informasi autentikasi pengguna tidak disertakan dalam permintaan. Anda tidak memiliki izin yang diperlukan.
NoSuchVectorIndex	404	Indeks vektor yang ditentukan tidak ada.
QpsLimitExceeded	503	Pembatasan laju permintaan berdasarkan permintaan per detik (QPS).