Einbettungen sind eine numerische Darstellung von Texteingaben, die eine Reihe einzigartiger Anwendungsfälle wie Clustering, Ähnlichkeitsmessung und Informationsabruf eröffnet. Eine Einführung finden Sie im Leitfaden zu Einbettungen.
Methode: models.embedContent
Generiert einen Texteinbettungsvektor aus der Eingabe-Content
mithilfe des angegebenen Gemini-Einbettungsmodells.
Endpunkt
Beitrag https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContentPfadparameter
model
string
Erforderlich. Der Ressourcenname des Modells. Diese dient als ID für das Modell.
Dieser Name sollte mit einem Modellnamen übereinstimmen, der von der Methode models.list
zurückgegeben wird.
Format: models/{model}
. Muss die Form models/{model}
haben.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
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. Optionaler Titel für den Text. Gilt nur, wenn der TaskType RETRIEVAL_DOCUMENT
ist.
Hinweis: Wenn Sie für RETRIEVAL_DOCUMENT
eine title
angeben, werden für das Abrufen Einbettungen mit höherer Qualität verwendet.
outputDimensionality
integer
Optional. Optionale reduzierte Dimension für die Ausgabe-Embedding. Wenn festgelegt, werden übermäßig viele Werte in der Ausgabeeinbettung vom Ende abgeschnitten. Wird nur von neueren Modellen seit 2024 unterstützt. Sie können diesen Wert nicht festlegen, wenn Sie das frühere Modell (models/embedding-001
) verwenden.
Beispielanfrage
Python
Node.js
Muschel
Antworttext
Die Antwort auf ein EmbedContentRequest
.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
embedding
object (ContentEmbedding
)
Nur Ausgabe. Die Einbettung, die aus den Eingabeinhalten generiert wurde.
JSON-Darstellung |
---|
{
"embedding": {
object ( |
Methode: models.batchEmbedContents
- Endpunkt
- Pfadparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- Beispielanfrage
- EmbedContentRequest
Generiert mehrere Einbettungsvektoren aus der Eingabe Content
, die aus einer Reihe von Strings besteht, die als EmbedContentRequest
-Objekte dargestellt werden.
Endpunkt
Beitrag https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContentsPfadparameter
model
string
Erforderlich. Der Ressourcenname des Modells. Diese dient als ID für das Modell.
Dieser Name sollte mit einem Modellnamen übereinstimmen, der von der Methode models.list
zurückgegeben wird.
Format: models/{model}
. Muss die Form models/{model}
haben.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
requests[]
object (EmbedContentRequest
)
Erforderlich. Anfragen für den Batch einbetten Das Modell in jeder dieser Anfragen muss mit dem angegebenen Modell BatchEmbedContentsRequest.model
übereinstimmen.
Beispielanfrage
Python
Node.js
Muschel
Antworttext
Die Antwort auf eine BatchEmbedContentsRequest
.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
embeddings[]
object (ContentEmbedding
)
Nur Ausgabe. Die Einbettungen für jede Anfrage in der Reihenfolge, in der sie in der Batchanfrage angegeben wurden.
JSON-Darstellung |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
Anfrage mit der Content
für das einzubettende Modell.
model
string
Erforderlich. Der Ressourcenname des Modells. Dies 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. Optionaler Titel für den Text. Gilt nur, wenn der TaskType RETRIEVAL_DOCUMENT
ist.
Hinweis: Wenn Sie für RETRIEVAL_DOCUMENT
eine title
angeben, werden für das Abrufen Einbettungen mit höherer Qualität verwendet.
outputDimensionality
integer
Optional. Optionale reduzierte Dimension für die Ausgabeeinbettung. Wenn festgelegt, werden übergroße Werte in der Ausgabe-Embedding am Ende abgeschnitten. Unterstützt nur von neueren Modellen seit 2024. Sie können diesen Wert nicht festlegen, wenn Sie das frühere Modell (models/embedding-001
) verwenden.
ContentEmbedding
Eine Liste von Gleitkommazahlen, die eine Einbettung darstellen.
values[]
number
Die Einbettungswerte.
JSON-Darstellung |
---|
{ "values": [ number ] } |
TaskType
Art der Aufgabe, für die die Einbettung verwendet wird.
Enums | |
---|---|
TASK_TYPE_UNSPECIFIED |
Nicht festgelegter Wert, der standardmäßig zu einem der anderen Enum-Werte wird. |
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 der angegebene Text zur Beantwortung der Frage verwendet wird. |
FACT_VERIFICATION |
Gibt an, dass der angegebene Text für die Faktenüberprüfung verwendet wird. |