PutVectorIndex API'si, bir vector paket içinde vektör dizini oluşturur.
Notlar
Tek bir vector pakette en fazla 100 vektör dizini bulunabilir.
Saniyede en fazla 5 PutVectorIndex isteği desteklenir.
İzinler
Varsayılan olarak Alibaba Cloud hesapları tüm izinlere sahipken Resource Access Management (RAM) kullanıcılarının ve RAM rollerinin herhangi bir izni yoktur. Alibaba Cloud hesabı veya bir yönetici, RAM ilkesi veya paket ilkesi aracılığıyla izin vermelidir.
|
|
|
|
|
|
|
|
İstek sözdizimi
POST /?putVectorIndex HTTP/1.1
Host: examplebucket-123***456.cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue
Content-type: application/json
{
"dataType": "string",
"dimension": int,
"distanceMetric": "string",
"indexName": "string",
"metadata": {
"nonFilterableMetadataKeys": [string, string]
}
}
İstek üst bilgileri
Bu işlem yalnızca ortak istek üst bilgilerini kullanır. Daha fazla bilgi için bkz. Ortak istek üst bilgileri.
İstek parametreleri
|
Ad |
Veri türü |
Gerekli |
Örnek |
Açıklama |
|
dataType |
String |
Evet |
float32 |
Vektör verilerinin veri türü. Bu parametre kullanıcılar tarafından yapılandırılamaz. Varsayılan değer: float32. |
|
dimension |
Değer |
Evet |
512 |
Vektör boyutu. Geçerli değerler: 1 ile 4096 arasında. Varsayılan değer: 512. |
|
distanceMetric |
String |
Evet |
euclidean |
Mesafe ölçüm işlevi. Geçerli değerler:
|
|
indexName |
String |
Evet |
vectorindex1 |
Dizinin özel adı.
|
|
metadata |
Object |
Hayır |
- |
Meta veri yapılandırmaları için kapsayıcı. Yalnızca filtrelenemez meta veriler desteklenir. |
|
nonFilterableMetadataKeys |
Dize dizisi |
Hayır |
["field1", "field2"] | Filtrelenemez meta veriler için yapılandırma. Aşağıdaki sınırlamalar geçerlidir:
Üst düğüm: metadata |
Yanıt üst bilgileri
Bu işlem yalnızca ortak yanıt üst bilgilerini kullanır. Daha fazla bilgi için bkz. Ortak yanıt üst bilgileri.
Örnekler
Örnek istek
POST /?putVectorIndex 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
{
"dataType": "float32",
"dimension": 1024,
"distanceMetric": "euclidean",
"indexName": "vectorindex1",
"metadata": {
"nonFilterableMetadataKeys": ["category", "timestamp"]
}
}
Örnek yanıt
HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Thu, 17 Apr 2025 01:33:47 GMT
Connection: keep-alive
Server: AliyunOSS
SDK
PutVectorIndex API'si aşağıdaki yazılım geliştirme kitleri (SDK'ler) tarafından desteklenir:
ossutil komut satırı aracı
Bu işlemi ossutil komut satırı aracıyla çağırmak için bkz. put-vector-index.
Hata kodları
|
Hata kodu |
HTTP durum kodu |
Açıklama |
|
VectorIndexParameterInvalid |
400 |
İstekte sağlanan vektör dizini parametreleri geçersiz. |
|
MalformedJson |
400 |
İstek gövdesindeki JSON biçimi geçersiz. |
|
VectorBucketIndexExceedLimit |
400 |
Oluşturulan dizin sayısı üst sınıra ulaştı. Tek bir vector pakette en fazla 100 vektör dizini oluşturulabilir. |
|
AccessDenied |
403 |
Bu hata aşağıdaki olası nedenlerle döndürülür:
|
|
VectorBucketIndexAlreadyExist |
409 |
Belirtilen dizin adı zaten var. Aynı ada sahip bir dizin oluşturamazsınız. |