REST Resource: projects.locations.collections.indexes

Risorsa: Index

Messaggio che descrive l'oggetto Index

Rappresentazione 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.
}
Campi
name

string

Identifier. name of resource
displayName

string

Facoltativo. Nome visualizzato dell'indice specificato dall'utente
description

string

Facoltativo. Descrizione dell'indice specificata dall'utente
labels

map (key: string, value: string)

Facoltativo. Etichette come coppie chiave-valore.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo output. [Solo output] Timestamp creazione

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. [Solo output] Timestamp aggiornamento

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
distanceMetric

enum (DistanceMetric)

Facoltativo. Metrica della distanza utilizzata per l'indicizzazione. Se non specificato, il valore predefinito è DOT_PRODUCT.
indexField

string

Obbligatorio. Il campo dello schema della raccolta da indicizzare.
filterFields[]

string

Facoltativo. I campi da inserire nell'indice per attivare il filtro in linea ANN rapido.
storeFields[]

string

Facoltativo. I campi da inserire nell'indice per consentire il recupero dei dati in linea.
Campo unione infra_type. Il tipo di infrastruttura dell'indice. infra_type può essere solo uno dei seguenti tipi:
dedicatedInfrastructure

object (DedicatedInfrastructure)

Facoltativo. Infrastruttura dedicata per l'indice.
Campo unione index_type. Il tipo di indice. index_type può essere solo uno dei seguenti tipi:
denseScann

object (DenseScannIndex)

Facoltativo. Indice ScaNN denso.

DedicatedInfrastructure

Rappresenta l'infrastruttura dedicata per l'indice.

Rappresentazione JSON 
{
  "autoscalingSpec": {
    object (AutoscalingSpec)
  },
  "mode": enum (Mode)
}
Campi
autoscalingSpec

object (AutoscalingSpec)

Facoltativo. Specifica di scalabilità automatica.
mode

enum (Mode)

Facoltativo. Modalità dell'infrastruttura dedicata.

Modalità

Modalità dell'infrastruttura dedicata.

Enum
MODE_UNSPECIFIED Il valore predefinito utilizzerà PERFORMANCE_OPTIMIZED.
STORAGE_OPTIMIZED Questa è la variante ottimizzata per l'archiviazione.
PERFORMANCE_OPTIMIZED Si tratta di un'ottimizzazione del rendimento su E2 o una famiglia equivalente.

AutoscalingSpec

Specifica per la scalabilità automatica.

Rappresentazione JSON 
{
  "minReplicaCount": integer,
  "maxReplicaCount": integer
}
Campi
minReplicaCount

integer

Facoltativo. Il numero minimo di repliche. Se non viene impostato o se è impostato su 0, il valore predefinito è 2. Deve essere >= 1 e <= 1000.
maxReplicaCount

integer

Facoltativo. Il numero massimo di repliche. Deve essere >= minReplicaCount e <= 1000. Per la versione v1beta, se non è impostato o è impostato su 0, il valore predefinito è il maggiore tra minReplicaCount e 5. Per tutte le altre versioni, se non è impostato o è impostato su 0, il valore predefinito è il maggiore tra minReplicaCount e 2.

DenseScannIndex

Configurazione dell'indice ScaNN denso.

Rappresentazione JSON 
{
  "featureNormType": enum (FeatureNormType)
}
Campi
featureNormType

enum (FeatureNormType)

Facoltativo. Tipo di normalizzazione delle caratteristiche.

FeatureNormType

Tipo di normalizzazione delle caratteristiche per l'indice ScaNN.

Enum
FEATURE_NORM_TYPE_UNSPECIFIED Tipo di normalizzazione delle caratteristiche non specificato.
NONE Nessuna norma applicata.
UNIT_L2_NORM Norma L2 unitaria.

DistanceMetric

Metrica di distanza per la ricerca vettoriale.

Enum
DISTANCE_METRIC_UNSPECIFIED Valore predefinito, la metrica di distanza non è specificata.
DOT_PRODUCT Metrica di distanza prodotto scalare.
COSINE_DISTANCE Metrica della distanza coseno.

Metodi

create

 Crea un nuovo indice in un progetto e una località specifici.

delete

 Elimina un singolo indice.

get

 Recupera i dettagli di un singolo indice.

list

 Elenca gli indici in un progetto e una località specifici.

patch

 Aggiorna i parametri di un singolo indice.