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

  // 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.
}
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 Abrufen von Inline-Daten zu ermöglichen.
Union-Feld infra_type. Der Infrastrukturtyp des Index. Für infra_type ist nur einer der folgenden Werte zulässig:
dedicatedInfrastructure

object (DedicatedInfrastructure)

Optional. Dedizierte Infrastruktur für den Index.
Union-Feld index_type. Der Typ des Index. Für index_type ist nur einer der folgenden Werte zulässig:
denseScann

object (DenseScannIndex)

Optional. Dichter ScaNN-Index

DedicatedInfrastructure

Stellt die dedizierte Infrastruktur für den Index dar.

JSON-Darstellung 
{
  "autoscalingSpec": {
    object (AutoscalingSpec)
  },
  "mode": enum (Mode)
}
Felder
autoscalingSpec

object (AutoscalingSpec)

Optional. Autoscaling-Spezifikation.
mode

enum (Mode)

Optional. Modus der dedizierten Infrastruktur.

Modus

Modus der dedizierten Infrastruktur.

Enums
MODE_UNSPECIFIED Standardmäßig wird PERFORMANCE_OPTIMIZED verwendet.
STORAGE_OPTIMIZED Dies ist eine speicheroptimierte Variante.
PERFORMANCE_OPTIMIZED Diese ist für die E2-Familie oder eine gleichwertige Familie optimiert.

AutoscalingSpec

Spezifikation für das Autoscaling.

JSON-Darstellung 
{
  "minReplicaCount": integer,
  "maxReplicaCount": integer
}
Felder
minReplicaCount

integer

Optional. Die Mindestanzahl von Replikaten. Wenn der Wert nicht festgelegt oder auf 0 gesetzt ist, wird standardmäßig 2 verwendet. Muss >= 1 und <= 1000 sein.
maxReplicaCount

integer

Optional. Die maximale Anzahl von Replikaten. Muss >= minReplicaCount und <= 1000 sein. Wenn für die Version v1beta kein Wert festgelegt ist oder der Wert 0 ist, wird standardmäßig der größere Wert von minReplicaCount und 5 verwendet. Für alle anderen Versionen gilt: Wenn der Wert nicht festgelegt oder auf 0 gesetzt ist, wird standardmäßig der größere Wert von minReplicaCount und 2 verwendet.

DenseScannIndex

Konfiguration für dichten ScaNN-Index.

JSON-Darstellung 
{
  "featureNormType": enum (FeatureNormType)
}
Felder
featureNormType

enum (FeatureNormType)

Optional. Typ der Featurenormalisierung.

FeatureNormType

Typ der Featurenormalisierung für den ScaNN-Index.

Enums
FEATURE_NORM_TYPE_UNSPECIFIED Nicht angegebener Typ der Featurenormalisierung.
NONE Es wurde keine Norm angewendet.
UNIT_L2_NORM Einheit-L2-Norm.

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.

patch

 Aktualisiert die Parameter eines einzelnen Index.