REST Resource: projects.locations.collections.indexes

Recurso: Index

Mensaje que describe el objeto Index

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
  ]
}
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 insertarán en el índice para habilitar el filtrado intercalado rápido de ANN.
storeFields[]

string

Es opcional. Son los campos que se insertarán en el índice para habilitar la recuperación de datos intercalados.

DistanceMetric

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

Enums
DISTANCE_METRIC_UNSPECIFIED Valor predeterminado: No se especificó 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 nuevo índice 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.