REST Resource: projects.locations.collections.indexes

Recurso: Index

Mensagem que descreve o objeto Index

Representação 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. Nome do recurso.
displayName

string

Opcional. Nome de exibição do índice especificado pelo usuário
description

string

Opcional. Descrição do índice especificada pelo usuário
labels

map (key: string, value: string)

Opcional. Rótulos como pares de chave-valor.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Apenas saída. [Apenas saída] Cria um carimbo de data/hora.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. [Apenas saída] Atualiza um carimbo de data/hora.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
distanceMetric

enum (DistanceMetric)

Opcional. Métrica de distância usada para indexação. Se não for especificado, o padrão será DOT_PRODUCT.
indexField

string

Obrigatório. O campo do esquema da coleção a ser indexado.
filterFields[]

string

Opcional. Os campos a serem enviados para o índice para ativar a filtragem inline rápida de ANN.
storeFields[]

string

Opcional. Os campos a serem enviados para o índice para ativar a recuperação de dados inline.

DistanceMetric

Métrica de distância para pesquisa de vetor.

Tipos enumerados
DISTANCE_METRIC_UNSPECIFIED Valor padrão, a métrica de distância não foi especificada.
DOT_PRODUCT Métrica de distância do produto escalar.
COSINE_DISTANCE Métrica de distância do cosseno.

Métodos

create

 Cria um novo índice em determinado projeto e local.

delete

 Exclui um único índice.

get

 Recebe detalhes de um único índice.

list

 Lista os índices em um determinado projeto e local.