Einbettungen sind eine numerische Darstellung von Texteingaben, die eine Reihe einzigartiger Anwendungsfälle ermöglichen, z. B. Clustering, Ähnlichkeitsmessung und Informationsabruf. Eine Einführung finden Sie im Leitfaden zu Einbettungen.
Im Gegensatz zu generativen KI-Modellen, die neue Inhalte erstellen, ist das Gemini Embedding-Modell nur dazu gedacht, das Format Ihrer Eingabedaten in eine numerische Darstellung umzuwandeln. Google ist zwar dafür verantwortlich, ein Einbettungsmodell bereitzustellen, das das Format Ihrer Eingabedaten in das angeforderte numerische Format umwandelt, die Nutzer behalten jedoch die volle Verantwortung für die von ihnen eingegebenen Daten und die resultierenden Einbettungen. Durch die Nutzung des Gemini Embedding-Modells bestätigen Sie, dass Sie über die erforderlichen Rechte für die von Ihnen hochgeladenen Inhalte verfügen. Erstellen Sie keine Inhalte, durch die die Rechte anderer, zum Beispiel Rechte an geistigem Eigentum oder das Recht auf Privatsphäre, verletzt werden. Ihre Nutzung dieses Dienstes unterliegt der Richtlinie zur unzulässigen Nutzung von generativer KI und den Google-Nutzungsbedingungen.
Methode: models.embedContent
Generiert einen Texteinbettungsvektor aus der Eingabe Content
mit dem angegebenen Gemini-Einbettungsmodell.
Endpunkt
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:embedContent
>
>
Pfadparameter
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}
. Es hat die Form models/{model}
.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
content
object (Content
)
Erforderlich. Der einzubettende Inhalt. Es werden nur die parts.text
-Felder gezählt.
taskType
enum (TaskType
)
Optional. Optionaler Aufgabentyp, für den die Einbettungen verwendet werden. Wird auf älteren Modellen (models/embedding-001
) nicht unterstützt.
title
string
Optional. Ein optionaler Titel für den Text. Gilt nur, wenn TaskType RETRIEVAL_DOCUMENT
ist.
Hinweis: Wenn Sie einen title
für RETRIEVAL_DOCUMENT
angeben, erhalten Sie Einbettungen mit höherer Qualität für den Abruf.
outputDimensionality
integer
Optional. Optionale reduzierte Dimension für die Ausgabe-Einbettung. Wenn festgelegt, werden übermäßige Werte in der Ausgabeeinbettung am Ende abgeschnitten. Wird nur von neueren Modellen ab 2024 unterstützt. Sie können diesen Wert nicht festlegen, wenn Sie das frühere Modell (models/embedding-001
) verwenden.
Beispielanfrage
Python
Node.js
Ok
Muschel
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von EmbedContentResponse
.
Methode: models.batchEmbedContents
Generiert mehrere Einbettungsvektoren aus der Eingabe Content
, die aus einem Batch von Strings besteht, die als EmbedContentRequest
-Objekte dargestellt werden.
Endpunkt
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:batchEmbedContents
>
>
Pfadparameter
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}
. Es hat die Form models/{model}
.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
requests[]
object (EmbedContentRequest
)
Erforderlich. Einbetten von Anfragen für den Batch Das Modell in jeder dieser Anfragen muss mit dem Modell übereinstimmen, das BatchEmbedContentsRequest.model
angegeben wurde.
Beispielanfrage
Python
Node.js
Ok
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 derselben Reihenfolge wie in der Batch-Anfrage.
JSON-Darstellung |
---|
{
"embeddings": [
{
object ( |
Methode: models.asyncBatchEmbedContent
Stellt einen Batch von models.embedContent
-Anfragen für die Batchverarbeitung in die Warteschlange. Wir haben einen models.batchEmbedContents
-Handler in GenerativeService
, aber er wurde synchronisiert. Um Verwirrung zu vermeiden, nennen wir sie Async
.
Endpunkt
posthttps: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:asyncBatchEmbedContent
>
>
Pfadparameter
batch.model
string
Erforderlich. Der Name des Model
, der zum Generieren der Vervollständigung verwendet werden soll.
Format: models/{model}
. Sie hat die Form models/{model}
.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
batch.name
string
Nur Ausgabe. ID. Ressourcenname des Batches.
Format: batches/{batchId}
.
batch.displayName
string
Erforderlich. Der benutzerdefinierte Name dieses Batches.
batch.inputConfig
object (InputEmbedContentConfig
)
Erforderlich. Eingabekonfiguration der Instanzen, auf denen die Batchverarbeitung ausgeführt wird.
batch.output
object (EmbedContentBatchOutput
)
Nur Ausgabe. Die Ausgabe der Batchanfrage.
batch.createTime
string (Timestamp
format)
Nur Ausgabe. Der Zeitpunkt, zu dem der Batch erstellt wurde.
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"
.
batch.endTime
string (Timestamp
format)
Nur Ausgabe. Der Zeitpunkt, zu dem die Batchverarbeitung abgeschlossen wurde.
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"
.
batch.updateTime
string (Timestamp
format)
Nur Ausgabe. Der Zeitpunkt, zu dem der Batch zuletzt aktualisiert wurde.
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"
.
batch.batchStats
object (EmbedContentBatchStats
)
Nur Ausgabe. Statistiken zum Batch.
batch.state
enum (BatchState
)
Nur Ausgabe. Der Status des Batches.
batch.priority
string (int64 format)
Optional. Die Priorität des Batches. Batches mit einem höheren Prioritätswert werden vor Batches mit einem niedrigeren Prioritätswert verarbeitet. Negative Werte sind zulässig. Der Standardwert ist 0.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation
.
EmbedContentRequest
Anfrage mit dem 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. Es werden nur die parts.text
-Felder gezählt.
taskType
enum (TaskType
)
Optional. Optionaler Aufgabentyp, für den die Einbettungen verwendet werden. Wird auf älteren Modellen (models/embedding-001
) nicht unterstützt.
title
string
Optional. Ein optionaler Titel für den Text. Gilt nur, wenn TaskType RETRIEVAL_DOCUMENT
ist.
Hinweis: Wenn Sie einen title
für RETRIEVAL_DOCUMENT
angeben, erhalten Sie Einbettungen mit höherer Qualität für den Abruf.
outputDimensionality
integer
Optional. Optionale reduzierte Dimension für die Ausgabe-Einbettung. Wenn festgelegt, werden übermäßige Werte in der Ausgabeeinbettung am Ende abgeschnitten. Wird nur von neueren Modellen ab 2024 unterstützt. Sie können diesen Wert nicht festlegen, wenn Sie das frühere Modell (models/embedding-001
) verwenden.
EmbedContentResponse
Die Antwort auf eine EmbedContentRequest
.
embedding
object (ContentEmbedding
)
Nur Ausgabe. Die aus den Eingabeinhalten generierte Einbettung.
JSON-Darstellung |
---|
{
"embedding": {
object ( |
ContentEmbedding
Eine Liste von Gleitkommazahlen, die ein Embedding 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 auf einen der anderen Enum-Werte gesetzt wird. |
RETRIEVAL_QUERY |
Gibt an, dass der angegebene Text eine Anfrage 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 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 für die Beantwortung von Fragen verwendet wird. |
FACT_VERIFICATION |
Gibt an, dass der angegebene Text für die Faktenprüfung verwendet wird. |
CODE_RETRIEVAL_QUERY |
Gibt an, dass der angegebene Text für den Codeabruf verwendet wird. |
EmbedContentBatch
- JSON-Darstellung
- InputEmbedContentConfig
- InlinedEmbedContentRequests
- InlinedEmbedContentRequest
- EmbedContentBatchOutput
- InlinedEmbedContentResponses
- InlinedEmbedContentResponse
- EmbedContentBatchStats
Eine Ressource, die einen Batch von EmbedContent
-Anfragen darstellt.
model
string
Erforderlich. Der Name des Model
, der zum Generieren der Vervollständigung verwendet werden soll.
Format: models/{model}
.
name
string
Nur Ausgabe. ID. Ressourcenname des Batches.
Format: batches/{batchId}
.
displayName
string
Erforderlich. Der benutzerdefinierte Name dieses Batches.
inputConfig
object (InputEmbedContentConfig
)
Erforderlich. Eingabekonfiguration der Instanzen, auf denen die Batchverarbeitung ausgeführt wird.
output
object (EmbedContentBatchOutput
)
Nur Ausgabe. Die Ausgabe der Batchanfrage.
createTime
string (Timestamp
format)
Nur Ausgabe. Der Zeitpunkt, zu dem der Batch erstellt wurde.
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"
.
endTime
string (Timestamp
format)
Nur Ausgabe. Der Zeitpunkt, zu dem die Batchverarbeitung abgeschlossen wurde.
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. Der Zeitpunkt, zu dem der Batch zuletzt aktualisiert wurde.
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"
.
batchStats
object (EmbedContentBatchStats
)
Nur Ausgabe. Statistiken zum Batch.
state
enum (BatchState
)
Nur Ausgabe. Der Status des Batches.
priority
string (int64 format)
Optional. Die Priorität des Batches. Batches mit einem höheren Prioritätswert werden vor Batches mit einem niedrigeren Prioritätswert verarbeitet. Negative Werte sind zulässig. Der Standardwert ist 0.
JSON-Darstellung |
---|
{ "model": string, "name": string, "displayName": string, "inputConfig": { object ( |
InputEmbedContentConfig
Konfiguriert die Eingabe für die Batchanfrage.
source
Union type
source
ist nur einer der folgenden Werte zulässig:fileName
string
Der Name des File
, der die Eingabeanfragen enthält.
requests
object (InlinedEmbedContentRequests
)
Die Anfragen, die im Batch verarbeitet werden sollen.
JSON-Darstellung |
---|
{
// source
"fileName": string,
"requests": {
object ( |
InlinedEmbedContentRequests
Die Anfragen, die im Batch verarbeitet werden sollen, sofern sie als Teil der Batcherstellungsanfrage angegeben werden.
requests[]
object (InlinedEmbedContentRequest
)
Erforderlich. Die Anfragen, die im Batch verarbeitet werden sollen.
JSON-Darstellung |
---|
{
"requests": [
{
object ( |
InlinedEmbedContentRequest
Die Anfrage, die im Batch verarbeitet werden soll.
request
object (EmbedContentRequest
)
Erforderlich. Die Anfrage, die im Batch verarbeitet werden soll.
metadata
object (Struct
format)
Optional. Die Metadaten, die der Anfrage zugeordnet werden sollen.
JSON-Darstellung |
---|
{
"request": {
object ( |
EmbedContentBatchOutput
Die Ausgabe einer Batchanfrage. Dieser Wert wird im Feld AsyncBatchEmbedContentResponse
oder EmbedContentBatch.output
zurückgegeben.
output
Union type
output
ist nur einer der folgenden Werte zulässig:responsesFile
string
Nur Ausgabe. Die Datei-ID der Datei mit den Antworten. Die Datei ist eine JSONL-Datei mit einer einzelnen Antwort pro Zeile. Die Antworten sind EmbedContentResponse
-Nachrichten im JSON-Format. Die Antworten werden in derselben Reihenfolge wie die Eingabeanfragen verfasst.
inlinedResponses
object (InlinedEmbedContentResponses
)
Nur Ausgabe. Die Antworten auf die Anfragen im Batch. Wird zurückgegeben, wenn der Batch mit Inline-Anfragen erstellt wurde. Die Antworten werden in derselben Reihenfolge wie die Eingabeanfragen ausgegeben.
JSON-Darstellung |
---|
{
// output
"responsesFile": string,
"inlinedResponses": {
object ( |
InlinedEmbedContentResponses
Die Antworten auf die Anfragen im Batch.
inlinedResponses[]
object (InlinedEmbedContentResponse
)
Nur Ausgabe. Die Antworten auf die Anfragen im Batch.
JSON-Darstellung |
---|
{
"inlinedResponses": [
{
object ( |
InlinedEmbedContentResponse
Die Antwort auf eine einzelne Anfrage im Batch.
metadata
object (Struct
format)
Nur Ausgabe. Die Metadaten, die der Anfrage zugeordnet sind.
output
Union type
output
ist nur einer der folgenden Werte zulässig:error
object (Status
)
Nur Ausgabe. Der Fehler, der beim Verarbeiten der Anfrage aufgetreten ist.
response
object (EmbedContentResponse
)
Nur Ausgabe. Die Antwort auf die Anfrage.
JSON-Darstellung |
---|
{ "metadata": { object }, // output "error": { object ( |
EmbedContentBatchStats
Statistiken zum Batch.
requestCount
string (int64 format)
Nur Ausgabe. Die Anzahl der Anfragen im Batch.
successfulRequestCount
string (int64 format)
Nur Ausgabe. Die Anzahl der Anfragen, die erfolgreich verarbeitet wurden.
failedRequestCount
string (int64 format)
Nur Ausgabe. Die Anzahl der Anfragen, die nicht verarbeitet werden konnten.
pendingRequestCount
string (int64 format)
Nur Ausgabe. Die Anzahl der Anfragen, die noch nicht verarbeitet wurden.
JSON-Darstellung |
---|
{ "requestCount": string, "successfulRequestCount": string, "failedRequestCount": string, "pendingRequestCount": string } |