REST Resource: projects.locations.collections.indexes

Ressource : Index

Message décrivant l'objet Index

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "distanceMetric": enum (DistanceMetric),
  "indexField": string,
  "filterFields": [
    string
  ],
  "storeFields": [
    string
  ]
}
Champs
name

string

Identifiant, nom de la ressource
displayName

string

Facultatif. Nom à afficher de l'index spécifié par l'utilisateur
description

string

Facultatif. Description de l'index spécifiée par l'utilisateur
labels

map (key: string, value: string)

Facultatif. Étiquettes sous forme de paires clé/valeur.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Uniquement en sortie. [Sortie uniquement] Code temporel de création

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. [Sortie uniquement] Code temporel de mise à jour

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
distanceMetric

enum (DistanceMetric)

Facultatif. Métrique de distance utilisée pour l'indexation. Si aucune valeur n'est spécifiée, la valeur par défaut est DOT_PRODUCT.
indexField

string

Obligatoire. Champ du schéma de la collection à indexer.
filterFields[]

string

Facultatif. Champs à insérer dans l'index pour activer le filtrage ANN rapide intégré.
storeFields[]

string

Facultatif. Champs à insérer dans l'index pour permettre la récupération des données en ligne.

DistanceMetric

Métrique de distance pour la recherche vectorielle.

Enums
DISTANCE_METRIC_UNSPECIFIED Valeur par défaut, la métrique de distance n'est pas spécifiée.
DOT_PRODUCT Métrique de distance de produit scalaire.
COSINE_DISTANCE Métrique de distance de cosinus.

Méthodes

create

 Crée un index dans un projet et un emplacement donnés.

delete

 Supprime un seul index.

get

 Récupère les détails d'un seul index.

list

 Liste les index d'un projet et d'un emplacement donnés.