Gunakan operasi ListVectors untuk mencantumkan data vektor dari indeks vektor - Object Storage Service

Operasi ListVectors menampilkan semua data vektor dalam sebuah indeks vektor.

Permissions

Secara default, Akun Alibaba Cloud memiliki izin penuh, sedangkan pengguna Resource Access Management (RAM) dan Peran RAM di bawah akun tersebut tidak memiliki izin apa pun. Akun Alibaba Cloud atau administrator harus memberikan izin melalui Kebijakan RAM atau kebijakan bucket.

API	Action	Description
ListVectors	`oss:ListVectors`	Menampilkan data vektor.

Sintaksis 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
}

Request headers

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

Parameter permintaan

Name	Data type	Required	Example	Description
indexName	String	Yes	vectorindex1	Nama indeks.
maxResults	value	No	500	Jumlah maksimum hasil yang dikembalikan dalam setiap panggilan. Nilai default adalah 500. Nilai maksimum adalah 1000.
nextToken	String	No	CAESCG15aC-xxxxx	Token kueri. Atur parameter ini ke nilai nextToken yang dikembalikan pada panggilan sebelumnya. Untuk panggilan pertama, biarkan parameter ini kosong. Panjang token dapat berkisar antara 1 hingga 2.048 byte.
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)
segmentCount	Value	No	1	Untuk panggilan ListVectors paralel, tentukan tingkat paralelisme. Nilai maksimum adalah 16. Untuk panggilan serial, atur parameter ini ke 1.
segmentIndex	value	No	0	Untuk panggilan ListVectors paralel, indeks segmen harus kurang dari segmentCount.

Response headers

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

Elemen respons

Name	Data type	Example	Description
nextToken	String	CAESCG15aC2xxxxx	Token untuk halaman hasil berikutnya. Jika parameter ini kosong, semua hasil telah dikembalikan.
vectors	Array of objects	N/A	Daftar vektor yang dikembalikan.
key	String	doc-001	Kunci primary dari vektor. Parent node: vectors
data	Object	N/A	Data vektor. Elemen ini hanya dikembalikan ketika returnData diatur ke true. Parent node: vectors
metadata	Object	N/A	Metadata. Elemen ini hanya dikembalikan ketika returnMetadata diatur ke true. Parent node: vectors

Contoh

Contoh permintaan

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
}

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

{
   "nextToken": "CAESCG15aC2xxxxx",
   "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

Operasi ListVectors didukung oleh kit pengembangan perangkat lunak (SDK) berikut:

Antarmuka baris perintah ossutil

Untuk perintah ossutil yang sesuai dengan operasi ListVectors, lihat list-vectors.

Kode error

Error code	HTTP status code	Description
VectorIndexParameterInvalid	400	Parameter indeks vektor yang diberikan dalam permintaan tidak valid.
MalformedJson	400	Format JSON pada badan permintaan tidak valid.
AccessDenied	403	Error ini dikembalikan karena alasan berikut: Informasi autentikasi pengguna tidak disertakan dalam permintaan. Anda tidak memiliki izin yang diperlukan untuk operasi ini.
NoSuchVectorIndex	404	Indeks vektor yang ditentukan tidak ada.
QpsLimitExceeded	503	Pembatasan kecepatan QPS (Queries Per Second) membatasi laju permintaan.