GetVectorIndex - API indeks vektor OSS - Object Storage Service

Mengambil konfigurasi indeks vektor, termasuk tipe data, dimensi, dan metrik jarak.

Izin

Akun Alibaba Cloud memiliki izin penuh secara default. Pengguna RAM dan Peran RAM memerlukan otorisasi eksplisit melalui Kebijakan RAM atau kebijakan bucket.

API	Action	Deskripsi
GetVectorIndex	`oss:GetVectorIndex`	Mengambil informasi indeks vektor.

Sintaks permintaan

POST /?getVectorIndex HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
{
   "indexName": "string"
}

Header permintaan

Operasi ini hanya menggunakan header permintaan umum.

Parameter permintaan

Nama	Tipe data	Wajib	Contoh	Deskripsi
indexName	string	Ya	vectorindex1	Nama indeks.

Header respons

Operasi ini hanya menggunakan header respons umum.

Elemen respons

Nama	Tipe data	Contoh	Deskripsi
index	Kontainer	-	Kontainer untuk informasi indeks vektor.
bucketArn	string	acs:ossvector:cn-hangzhou:174****:my-vector-bucket	Nama sumber daya (ARN) bucket vektor tempat indeks tersebut berada, dalam format acs:ossvector:{region}:{accountId}:{bucketName}. Node induk: index
indexName	string	vectorindex1	Nama indeks. Node induk: index
createTime	string	2025-04-17T10:56:21.000Z	Waktu pembuatan indeks dalam GMT. Node induk: index
dataType	string	float32	Tipe data vektor. Node induk: index
dimension	Integer	1024	Jumlah dimensi vektor. Node induk: index
distanceMetric	string	euclidean	Fungsi metrik jarak. Node induk: index
metadata	Kontainer	-	Konfigurasi metadata. Node induk: index
nonFilterableMetadataKeys	string array	["category", "timestamp"]	Bidang metadata yang tidak dapat difilter. Node induk: metadata
status	string	enable	Status indeks. Nilai yang valid: creating enable deleting
mode	string	fusion	Mode indeks. Nilai yang valid: standard (Standard mode) fusion (Fusion mode) Node induk: index

Catatan

Elemen respons di atas dikembalikan untuk indeks mode Standard. Untuk indeks mode Fusion, selain atribut dasar seperti index, bucketArn, indexName, createTime, mode, dan status, respons juga mengembalikan konfigurasi skema lengkap (schemaConfiguration) yang didefinisikan saat pembuatan indeks, dan tidak mengembalikan bidang mode Standard seperti dataType, dimension, dan distanceMetric. Indeks mode Standard dan mode Fusion dapat berada dalam bucket vektor yang sama.

Contoh

Mode Standard

Contoh permintaan

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

{
   "indexName": "vectorindex1"
}

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

{
   "index": { 
      "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
      "createTime": "2025-04-17T10:56:21.000Z",
      "indexName": "vectorindex1",
      "mode": "standard",
      "dataType": "float32",
      "dimension": 1024,
      "distanceMetric": "euclidean",
      "metadata": { 
         "nonFilterableMetadataKeys": ["category", "timestamp"]
      },
      "status": "enable"
   }
}

Mode Fusion

Contoh permintaan

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

{
   "indexName": "vectorindex1"
}

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

{
   "index": {
      "bucketArn": "acs:ossvector:cn-hangzhou:174****:my-vector-bucket",
      "createTime": "2025-04-17T10:56:21.000Z",
      "indexName": "vectorindex1",
      "mode": "fusion",
      "schemaConfiguration": {
         "fields": [
            {
               "name": "vector_1",
               "type": "vector",
               "dataType": "float32",
               "dimension": 1024,
               "distanceMetric": "euclidean"
            },
            {
               "name": "price",
               "type": "double"
            },
            {
               "name": "tag",
               "type": "string"
            },
            {
               "name": "user_id",
               "type": "string",
               "isPartitionKey": true
            }
         ]
      },
      "status": "enable"
   }
}

SDK

SDK yang tersedia untuk GetVectorIndex:

Antarmuka baris perintah ossutil

Jalankan GetVectorIndex dari command line dengan ossutil get-vector-index.

Kode kesalahan

Kode kesalahan	Kode status HTTP	Deskripsi
VectorIndexParameterInvalid	400	Parameter indeks vektor dalam permintaan tidak valid.
MalformedJson	400	JSON dalam badan permintaan tidak valid.
AccessDenied	403	Penyebab yang mungkin: Informasi autentikasi tidak ada dalam permintaan. Izin tidak mencukupi.
NoSuchVectorIndex	404	Indeks vektor tidak ada.