REST Resource: projects.locations.collections

Ressource: Sammlung

Nachricht zur Beschreibung des Sammlungsobjekts

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  },
  "encryptionSpec": {
    object (EncryptionSpec)
  }
}
Felder
name

string

Kennung. Name der Ressource
displayName

string

Optional. Vom Nutzer angegebener Anzeigename der Sammlung
description

string

Optional. Vom Nutzer angegebene Beschreibung der Sammlung
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".
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" }.
vectorSchema

map (key: string, value: object (VectorField))

Optional. Schema für Vektorfelder. Nur Vektorfelder in diesem Schema können durchsucht werden. Feldnamen dürfen nur alphanumerische Zeichen, Unterstriche und Bindestriche enthalten.

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

object (Struct format)

Optional. JSON-Schema für Daten. Feldnamen dürfen nur alphanumerische Zeichen, Unterstriche und Bindestriche enthalten. Das Schema muss mit JSON Schema Draft 7 kompatibel sein.
encryptionSpec

object (EncryptionSpec)

Optional. Nicht veränderbar. Gibt die Spezifikation für den kundenverwalteten Verschlüsselungsschlüssel für eine Sammlung an. Wenn festgelegt, werden diese Sammlung und alle Unterressourcen dieser Sammlung mit diesem Schlüssel geschützt.

VectorField

Nachricht zur Beschreibung eines Vektorfelds.

JSON-Darstellung 
{

  // Union field vector_type_config can be only one of the following:
  "denseVector": {
    object (DenseVectorField)
  },
  "sparseVector": {
    object (SparseVectorField)
  }
  // End of list of possible types for union field vector_type_config.
}
Felder
Union-Feld vector_type_config. Konfiguration des Vektortyps. Für vector_type_config ist nur einer der folgenden Werte zulässig:
denseVector

object (DenseVectorField)

Vektorfeld mit hoher Dichte.
sparseVector

object (SparseVectorField)

Dünnbesetztes Vektorfeld.

DenseVectorField

Nachricht zur Beschreibung eines Vektorfelds mit hoher Dichte.

JSON-Darstellung 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
Felder
dimensions

integer

Dimensionalität des Vektorfelds.
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

Optional. Konfiguration zum Generieren von Einbettungen für das Vektorfeld. Wenn nicht angegeben, muss das Einbettungsfeld im DataObject ausgefüllt sein.

VertexEmbeddingConfig

Nachricht zur Beschreibung der Konfiguration zum Generieren von Einbettungen für ein Vektorfeld mit der Vertex AI Embeddings API.

JSON-Darstellung 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
Felder
modelId

string

Erforderlich. Erforderlich: ID des zu verwendenden Einbettungsmodells. Eine Liste der unterstützten Modelle finden Sie unter https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models.
textTemplate

string

Erforderlich. Erforderlich: Textvorlage für die Eingabe in das Modell. Die Vorlage muss einen oder mehrere Verweise auf Felder im DataObject enthalten, z.B.: „Movie Title: {title} ---- Movie Plot: {plot}“.
taskType

enum (EmbeddingTaskType)

Erforderlich. Erforderlich: Aufgabentyp für die Einbettungen.

EmbeddingTaskType

Stellt die Aufgabe dar, für die die Einbettungen verwendet werden.

Enums
EMBEDDING_TASK_TYPE_UNSPECIFIED Nicht angegebener Aufgabentyp.
RETRIEVAL_QUERY Gibt an, dass der angegebene Text eine Abfrage in einer Such-/Abrufeinstellung ist.
RETRIEVAL_DOCUMENT Gibt an, dass der angegebene Text ein Dokument aus dem durchsuchten Korpus ist.
SEMANTIC_SIMILARITY Gibt an, dass der angegebene Text für die Bestimmung der semantischen Textähnlichkeit (Semantic Textual Similarity, STS) verwendet wird.
CLASSIFICATION Gibt an, dass der angegebene Text klassifiziert wird.
CLUSTERING Gibt an, dass die Einbettungen für das Clustering verwendet werden.
QUESTION_ANSWERING Gibt an, dass die Einbettungen für die Beantwortung von Fragen verwendet werden.
FACT_VERIFICATION Gibt an, dass die Einbettungen für die Faktenprüfung verwendet werden.
CODE_RETRIEVAL_QUERY Gibt an, dass die Einbettungen für den Abruf von Code verwendet werden.

SparseVectorField

Dieser Typ hat keine Felder.

Nachricht zur Beschreibung eines Vektorfelds mit geringer Dichte.

EncryptionSpec

Stellt eine Spezifikation für kundenverwaltete Verschlüsselungsschlüssel dar, die auf eine Vector Search-Sammlung angewendet werden kann.

JSON-Darstellung 
{
  "cryptoKeyName": string
}
Felder
cryptoKeyName

string

Erforderlich. Ressourcenname des Cloud KMS-Schlüssels, der zum Schutz der Ressource verwendet wird.

Der Cloud KMS-Schlüssel muss sich in derselben Region wie die Ressource befinden. Er muss das Format projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} haben.

Methoden

create

 Erstellt eine neue Sammlung in einem bestimmten Projekt und an einem bestimmten Standort.

delete

 Löscht eine einzelne Sammlung.

exportDataObjects

 Startet einen Vorgang mit langer Ausführungszeit, um DataObjects aus einer Sammlung zu exportieren.

get

 Ruft Details zu einer einzelnen Sammlung ab.

importDataObjects

 Startet einen Vorgang mit langer Ausführungszeit, um DataObjects in eine Sammlung zu importieren.

list

 Listet Sammlungen in einem bestimmten Projekt und an einem bestimmten Standort auf.

patch

 Aktualisiert die Parameter einer einzelnen Sammlung.