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
  ],

  // Union field infra_type can be only one of the following:
  "dedicatedInfrastructure": {
    object (DedicatedInfrastructure)
  }
  // End of list of possible types for union field infra_type.

  // Union field index_type can be only one of the following:
  "denseScann": {
    object (DenseScannIndex)
  }
  // End of list of possible types for union field index_type.
}
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 de schéma de la collection à indexer.
filterFields[]

string

Facultatif. Champs à envoyer dans l'index pour activer le filtrage en ligne rapide des voisins les plus proches (ANN).
storeFields[]

string

Facultatif. Champs à envoyer dans l'index pour activer la récupération des données en ligne.
Champ d'union infra_type. Type d'infrastructure de l'index. infra_type ne peut être qu'un des éléments suivants :
dedicatedInfrastructure

object (DedicatedInfrastructure)

Facultatif. Infrastructure dédiée pour l'index.
Champ d'union index_type. Type d'index. index_type ne peut être qu'un des éléments suivants :
denseScann

object (DenseScannIndex)

Facultatif. Index ScaNN dense.

DedicatedInfrastructure

Représente l'infrastructure dédiée pour l'index.

Représentation JSON 
{
  "autoscalingSpec": {
    object (AutoscalingSpec)
  },
  "mode": enum (Mode)
}
Champs
autoscalingSpec

object (AutoscalingSpec)

Facultatif. Spécification de l'autoscaling.
mode

enum (Mode)

Facultatif. Mode de l'infrastructure dédiée.

Mode

Mode de l'infrastructure dédiée.

Enums
MODE_UNSPECIFIED La valeur par défaut est PERFORMANCE_OPTIMIZED.
STORAGE_OPTIMIZED Il s'agit d'une variante optimisée pour le stockage.
PERFORMANCE_OPTIMIZED Il s'agit d'une variante optimisée pour les performances sur la famille E2 ou une famille équivalente.

AutoscalingSpec

Spécification de l'autoscaling.

Représentation JSON 
{
  "minReplicaCount": integer,
  "maxReplicaCount": integer
}
Champs
minReplicaCount

integer

Facultatif. Nombre minimal d'instances dupliquées. Si ce champ n'est pas défini ou est défini sur 0, la valeur par défaut est 2. Doit être supérieur ou égal à 1 et inférieur ou égal à 1000.
maxReplicaCount

integer

Facultatif. Nombre maximal d'instances dupliquées. Doit être supérieur ou égal à minReplicaCount et inférieur ou égal à 1000. Pour la version v1beta, si ce champ n'est pas défini ou est défini sur 0, la valeur par défaut est la plus grande valeur entre minReplicaCount et 5. Pour toutes les autres versions, si ce champ n'est pas défini ou est défini sur 0, la valeur par défaut est la plus grande valeur entre minReplicaCount et 2.

DenseScannIndex

Configuration de l'index ScaNN dense.

Représentation JSON 
{
  "featureNormType": enum (FeatureNormType)
}
Champs
featureNormType

enum (FeatureNormType)

Facultatif. Type de normalisation de caractéristique.

FeatureNormType

Type de normalisation de caractéristique pour l'index ScaNN.

Enums
FEATURE_NORM_TYPE_UNSPECIFIED Type de normalisation de caractéristique non spécifié.
NONE Aucune norme appliquée.
UNIT_L2_NORM Norme L2 unitaire.

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

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

patch

 Met à jour les paramètres d'un seul index.