GetVectorIndex - OSS vector index API - Object Storage Service

İzinler

Alibaba Cloud hesapları varsayılan olarak tam izinlere sahiptir. RAM kullanıcıları ve RAM rolleri için bir RAM ilkesi veya paket ilkesi aracılığıyla açık yetkilendirme gerekir.

API	Eylem	Açıklama
GetVectorIndex	`oss:GetVectorIndex`	Vektör dizini bilgilerini alır.

İstek sözdizimi

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

İstek üstbilgileri

Bu işlem yalnızca ortak istek üstbilgilerini kullanır.

İstek parametreleri

Ad	Veri türü	Gerekli	Örnek	Açıklama
indexName	string	Evet	vectorindex1	Dizin adı.

Yanıt üstbilgileri

Bu işlem yalnızca ortak yanıt üstbilgilerini kullanır.

Yanıt öğeleri

Ad	Veri türü	Örnek	Açıklama
index	konteyner	-	Vektör dizini bilgileri için kapsayıcı.
bucketArn	string	acs:ossvector:cn-hangzhou:174****:my-vector-bucket	Dizinin ait olduğu vektör paketinin kaynak adı (ARN). Biçim: acs:ossvector:{region}:{accountId}:{bucketName}. Üst düğüm: index
indexName	string	vectorindex1	Dizin adı. Üst düğüm: index
createTime	string	2025-04-17T10:56:21.000Z	GMT cinsinden dizin oluşturma zamanı. Üst düğüm: index
dataType	string	float32	Vektör veri türü. Üst düğüm: index
dimension	Integer	1024	Vektör boyutu sayısı. Üst düğüm: index
distanceMetric	string	euclidean	Mesafe metrik fonksiyonu. Üst düğüm: index
metadata	konteyner	-	Meta veri yapılandırması. Üst düğüm: index
nonFilterableMetadataKeys	string array	["category", "timestamp"]	Filtrelenemeyen meta veri alanları. Üst düğüm: metadata
status	string	enable	Dizin durumu. Geçerli değerler: creating enable deleting
mode	string	fusion	Dizin modu. Geçerli değerler: standard (Standart mod) fusion (Birleştirme modu) Üst düğüm: index

Not

Yukarıdaki yanıt öğeleri Standart mod dizinleri için döndürülür. Birleştirme modu dizinlerinde ise index, bucketArn, indexName, createTime, mode ve status gibi temel niteliklere ek olarak, dizin oluşturulurken tanımlanan tam şema yapılandırması (schemaConfiguration) da döndürülür; ancak dataType, dimension ve distanceMetric gibi Standart moda özgü alanlar döndürülmez. Standart mod ve Birleştirme modu dizinleri aynı vektör paketinde birlikte bulunabilir.

Örnekler

Standart Mod

İstek örneği

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

Yanıt örneği

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

Birleştirme Modu

İstek örneği

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

Yanıt örneği

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

GetVectorIndex için kullanılabilen SDK'lar:

ossutil komut satırı arabirimi

GetVectorIndex işlemini komut satırından ossutil get-vector-index ile çalıştırın.

Hata kodları

Hata kodu	HTTP durum kodu	Açıklama
VectorIndexParameterInvalid	400	İstekteki vektör dizini parametresi geçersiz.
MalformedJson	400	İstek gövdesindeki JSON geçersiz.
AccessDenied	403	Olası nedenler: İstekte kimlik doğrulama bilgisi eksik. Yetersiz izinler.
NoSuchVectorIndex	404	Vektör dizini mevcut değil.