REST Resource: projects.locations.collections.indexes

Risorsa: indice

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
  ]
}
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 di 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.

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.