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

  // 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. 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 rápida em linha de ANN.
storeFields[]

string

Opcional. Os campos a serem enviados por push para o índice para ativar a recuperação de dados inline.
Campo de união infra_type. O tipo de infraestrutura do índice. infra_type pode ser apenas de um dos tipos a seguir:
dedicatedInfrastructure

object (DedicatedInfrastructure)

Opcional. Infraestrutura dedicada para o índice.
Campo de união index_type. O tipo do índice. index_type pode ser apenas de um dos tipos a seguir:
denseScann

object (DenseScannIndex)

Opcional. Índice denso do ScaNN.

DedicatedInfrastructure

Representa a infraestrutura dedicada ao índice.

Representação JSON 
{
  "autoscalingSpec": {
    object (AutoscalingSpec)
  },
  "mode": enum (Mode)
}
Campos
autoscalingSpec

object (AutoscalingSpec)

Opcional. Especificação de escalonamento automático.
mode

enum (Mode)

Opcional. Modo da infraestrutura dedicada.

Modo

Modo da infraestrutura dedicada.

Tipos enumerados
MODE_UNSPECIFIED O padrão usa PERFORMANCE_OPTIMIZED.
STORAGE_OPTIMIZED Esta é uma variação otimizada para armazenamento.
PERFORMANCE_OPTIMIZED Essa é a família E2 ou equivalente otimizada para performance.

AutoscalingSpec

Especificação para escalonamento automático.

Representação JSON 
{
  "minReplicaCount": integer,
  "maxReplicaCount": integer
}
Campos
minReplicaCount

integer

Opcional. O número mínimo de réplicas. Se não for definido ou for definido como 0, o padrão será 2. Precisa ser >= 1 e <= 1000.
maxReplicaCount

integer

Opcional. O número máximo de réplicas. Precisa ser >= minReplicaCount e <= 1000. Para a versão v1beta, se não for definido ou for definido como 0, o padrão será o maior valor entre minReplicaCount e 5. Para todas as outras versões, se não estiver definido ou estiver definido como 0, o padrão será o maior valor entre minReplicaCount e 2.

DenseScannIndex

Configuração de índice ScaNN denso.

Representação JSON 
{
  "featureNormType": enum (FeatureNormType)
}
Campos
featureNormType

enum (FeatureNormType)

Opcional. Tipo de normalização do recurso.

FeatureNormType

Tipo de normalização de recurso para o índice ScaNN.

Tipos enumerados
FEATURE_NORM_TYPE_UNSPECIFIED Tipo de normalização de recurso não especificado.
NONE Nenhuma norma aplicada.
UNIT_L2_NORM Norma L2 da unidade.

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.

patch

 Atualiza os parâmetros de um único índice.