REST Resource: projects.locations.collections.indexes

Ressource: Index

Nachricht zur Beschreibung des Index-Objekts

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "distanceMetric": enum (DistanceMetric),
  "indexField": string,
  "filterFields": [
    string
  ],
  "storeFields": [
    string
  ]
}
Felder
name

string

Kennung. Name der Ressource
displayName

string

Optional. Vom Nutzer angegebener Anzeigename des Index
description

string

Optional. Vom Nutzer angegebene Beschreibung des Index
labels

map (key: string, value: string)

Optional. Labels als Schlüssel/Wert-Paare.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Nur Ausgabe. [Nur Ausgabe] Zeitstempel der Erstellung

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime

string (Timestamp format)

Nur Ausgabe. [Nur Ausgabe] Zeitstempel der Aktualisierung

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
distanceMetric

enum (DistanceMetric)

Optional. Für die Indexierung verwendeter Distanzmesswert. Wenn nichts angegeben ist, wird standardmäßig DOT_PRODUCT verwendet.
indexField

string

Erforderlich. Das Feld des Sammlungsschemas, das indexiert werden soll.
filterFields[]

string

Optional. Die Felder, die in den Index aufgenommen werden sollen, um schnelles Inline-Filtern mit ANN zu ermöglichen.
storeFields[]

string

Optional. Die Felder, die in den Index übertragen werden sollen, um das Inline-Abrufen von Daten zu ermöglichen.

DistanceMetric

Distanzmesswert für die Vektorsuche.

Enums
DISTANCE_METRIC_UNSPECIFIED Standardwert, wenn keine Distanzmessung angegeben ist.
DOT_PRODUCT Metrik für die Punktprodukt-Distanz.
COSINE_DISTANCE Metrik für die Kosinus-Distanz.

Methoden

create

 Erstellt einen neuen Index in einem bestimmten Projekt und an einem bestimmten Standort.

delete

 Löscht einen einzelnen Index.

get

 Ruft Details zu einem einzelnen Index ab.

list

 Listet Indexe in einem angegebenen Projekt und an einem angegebenen Standort auf.