REST Resource: projects.locations.collections.indexes

Recurso: Index

Mensaje que describe el objeto de índice

Representación 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.
}
Campos
name

string

Identificador. Nombre del recurso
displayName

string

Es opcional. Nombre visible del índice especificado por el usuario
description

string

Es opcional. Descripción del índice especificada por el usuario
labels

map (key: string, value: string)

Es opcional. Son etiquetas como pares clave-valor.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo salida. [Solo salida] Marca de tiempo de creación

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. [Solo salida] Marca de tiempo de actualización

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
distanceMetric

enum (DistanceMetric)

Es opcional. Es la métrica de distancia que se usa para la indexación. Si no se especifica, se usará DOT_PRODUCT de forma predeterminada.
indexField

string

Obligatorio. Es el campo del esquema de la colección que se indexará.
filterFields[]

string

Es opcional. Son los campos que se deben enviar al índice para habilitar el filtrado intercalado rápido de ANN.
storeFields[]

string

Es opcional. Son los campos que se deben enviar al índice para habilitar la recuperación de datos intercalados.
Campo de unión infra_type. Es el tipo de infraestructura del índice. infra_type puede ser solo uno de los parámetros siguientes:
dedicatedInfrastructure

object (DedicatedInfrastructure)

Es opcional. Infraestructura dedicada para el índice
Campo de unión index_type. Es el tipo de índice. index_type puede ser solo uno de los parámetros siguientes:
denseScann

object (DenseScannIndex)

Es opcional. Es un índice de ScaNN denso.

DedicatedInfrastructure

Representa la infraestructura dedicada para el índice.

Representación JSON 
{
  "autoscalingSpec": {
    object (AutoscalingSpec)
  },
  "mode": enum (Mode)
}
Campos
autoscalingSpec

object (AutoscalingSpec)

Es opcional. Es la especificación del ajuste de escala automático.
mode

enum (Mode)

Es opcional. Es el modo de la infraestructura dedicada.

Modo

Es el modo de la infraestructura dedicada.

Enums
MODE_UNSPECIFIED El valor predeterminado usará PERFORMANCE_OPTIMIZED.
STORAGE_OPTIMIZED Esta es una variación optimizada para el almacenamiento.
PERFORMANCE_OPTIMIZED Esta opción está optimizada para el rendimiento en la familia E2 o equivalente.

AutoscalingSpec

Es la especificación del ajuste de escala automático.

Representación JSON 
{
  "minReplicaCount": integer,
  "maxReplicaCount": integer
}
Campos
minReplicaCount

integer

Es opcional. Es la cantidad mínima de réplicas. Si no se establece o se configura como 0, el valor predeterminado es 2. Debe ser >= 1 y <= 1000.
maxReplicaCount

integer

Es opcional. Es la cantidad máxima de réplicas. Debe ser >= minReplicaCount y <= 1000. Para la versión v1beta, si no se configura o se establece en 0, el valor predeterminado es el mayor entre minReplicaCount y 5. Para todas las demás versiones, si no se establece o se establece en 0, el valor predeterminado es el mayor de minReplicaCount y 2.

DenseScannIndex

Es la configuración del índice de ScaNN denso.

Representación JSON 
{
  "featureNormType": enum (FeatureNormType)
}
Campos
featureNormType

enum (FeatureNormType)

Es opcional. Es el tipo de normalización del atributo.

FeatureNormType

Es el tipo de norma del atributo para el índice de ScaNN.

Enums
FEATURE_NORM_TYPE_UNSPECIFIED Es un tipo de norma de características sin especificar.
NONE No se aplicó ninguna norma.
UNIT_L2_NORM Norma L2 de la unidad.

DistanceMetric

Es la métrica de distancia para la búsqueda de vectores.

Enums
DISTANCE_METRIC_UNSPECIFIED Valor predeterminado, no se especifica la métrica de distancia.
DOT_PRODUCT Métrica de distancia del producto punto.
COSINE_DISTANCE Métrica de distancia de coseno.

Métodos

create

 Crea un índice nuevo en un proyecto y una ubicación determinados.

delete

 Borra un solo índice.

get

 Obtiene detalles de un solo índice.

list

 Enumera los índices en una ubicación y un proyecto determinados.

patch

 Actualiza los parámetros de un solo índice.