Method: models.batchEmbedContents

Generiert in einem synchronen Aufruf aus dem Modell mehrere Einbettungen anhand des Eingabetexts.

HTTP-Anfrage

POST https://generativelanguage.googleapis.com/v1/{model=models/*}:batchEmbedContents

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
model

string

Erforderlich. Der Ressourcenname des Modells. Sie dient als ID für das zu verwendende Modell.

Dieser Name sollte mit einem Modellnamen übereinstimmen, der von der Methode models.list zurückgegeben wird.

Format: models/{model}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requests": [
    {
      object (EmbedContentRequest)
    }
  ]
}
Felder
requests[]

object (EmbedContentRequest)

Erforderlich. Betten Sie Anfragen für den Batch ein. Das Modell in jeder dieser Anfragen muss mit dem für BatchEmbedContentsRequest.model angegebenen Modell übereinstimmen.

Antworttext

Die Antwort auf ein BatchEmbedContentsRequest-Objekt.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "embeddings": [
    {
      object (ContentEmbedding)
    }
  ]
}
Felder
embeddings[]

object (ContentEmbedding)

Nur Ausgabe. Die Einbettungen für jede Anfrage, in derselben Reihenfolge wie in der Batchanfrage angegeben

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

EmbedContentRequest

Anfrage mit der Content für das einzubettende Modell.

JSON-Darstellung 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
Felder
model

string

Erforderlich. Der Ressourcenname des Modells. Sie dient als ID für das zu verwendende Modell.

Dieser Name sollte mit einem Modellnamen übereinstimmen, der von der Methode models.list zurückgegeben wird.

Format: models/{model}
content

object (Content)

Erforderlich. Der einzubettende Inhalt. Nur die parts.text-Felder werden gezählt.
taskType

enum (TaskType)

Optional. Optionaler Aufgabentyp, für den die Einbettungen verwendet werden. Kann nur für models/embedding-001 festgelegt werden.
title

string

Optional. Ein optionaler Titel für den Text. Gilt nur, wenn der TaskType RETRIEVAL_DOCUMENT ist.

Hinweis: Wenn Sie eine title für RETRIEVAL_DOCUMENT angeben, ist die Qualität der Einbettungen beim Abrufen besser.
outputDimensionality

integer

Optional. Optionale reduzierte Abmessungen für die Ausgabeeinbettung. Wenn festgelegt, werden übermäßig viele Werte in der Ausgabeeinbettung am Ende abgeschnitten. Wird seit 2024 von neueren Modellen unterstützt. Beim älteren Modell (models/embedding-001) kann dieser Wert nicht angegeben werden.