GetVectorIndex - API d'index vectoriel OSS - Object Storage Service

Permissions

Les comptes Alibaba Cloud disposent par défaut de toutes les autorisations. Les utilisateurs RAM et les rôles RAM nécessitent une autorisation explicite via une politique RAM ou une politique de bucket.

API

Action

Description

GetVectorIndex

oss:GetVectorIndex

Récupère les informations relatives à l'index vectoriel.

Syntaxe de la requête

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

En-têtes de requête

Cette opération utilise uniquement les en-têtes de requête communs.

Paramètres de requête

Nom

Type de données

Obligatoire

Exemple

Description

indexName

string

Oui

vectorindex1

Nom de l'index.

En-têtes de réponse

Cette opération utilise uniquement les en-têtes de réponse communs.

Éléments de réponse

Nom	Type de données	Exemple	Description
index	container	-	Conteneur des informations relatives à l'index vectoriel.
bucketArn	string	acs:ossvector:cn-hangzhou:174****:my-vector-bucket	Nom de ressource (ARN) du bucket vectoriel auquel appartient l'index, au format acs:ossvector:{region}:{accountId}:{bucketName}. Nœud parent : index
indexName	string	vectorindex1	Nom de l'index. Nœud parent : index
createTime	string	2025-04-17T10:56:21.000Z	Heure de création de l'index au format GMT. Nœud parent : index
dataType	string	float32	Type de données vectorielles. Nœud parent : index
dimension	Integer	1024	Nombre de dimensions du vecteur. Nœud parent : index
distanceMetric	string	euclidean	Fonction de métrique de distance. Nœud parent : index
metadata	container	-	Configuration des métadonnées. Nœud parent : index
nonFilterableMetadataKeys	string array	["category", "timestamp"]	Champs de métadonnées non filtrables. Nœud parent : metadata
status	string	enable	Statut de l'index. Valeurs valides : creating enable deleting
mode	string	fusion	Mode de l'index. Valeurs valides : standard (Mode standard) fusion (Mode fusion) Nœud parent : index

Remarque

Les éléments de réponse précédents sont renvoyés pour les index en mode standard. Pour les index en mode fusion, outre les attributs de base tels que index, bucketArn, indexName, createTime, mode et status, la réponse renvoie également la configuration complète du schéma (schemaConfiguration) définie lors de la création de l'index, et ne renvoie pas les champs du mode standard tels que dataType, dimension et distanceMetric. Les index en mode standard et en mode fusion peuvent coexister dans le même bucket vectoriel.

Exemples

Mode standard

Exemple de requête

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

Exemple de réponse

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

Exemple de requête

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

Exemple de réponse

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 disponibles pour GetVectorIndex :

Interface de ligne de commande ossutil

Exécutez GetVectorIndex depuis la ligne de commande avec ossutil get-vector-index.

Codes d'erreur

Code d'erreur	Code d'état HTTP	Description
VectorIndexParameterInvalid	400	Paramètre d'index vectoriel invalide dans la requête.
MalformedJson	400	JSON invalide dans le corps de la requête.
AccessDenied	403	Causes possibles : Informations d'authentification manquantes dans la requête. Autorisations insuffisantes.
NoSuchVectorIndex	404	L'index vectoriel n'existe pas.