Methode: model.embedContent
- Endpunkt
- Pfadparameter
- Anfragetext
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Antworttext
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Autorisierungsbereiche
- Beispielanfrage
<ph type="x-smartling-placeholder">
- </ph>
- Basic
Erzeugt eine Einbettung aus dem Modell anhand einer Content
-Eingabe.
Endpunkt
<ph type="x-smartling-placeholder"></ph> Beitrag
https://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}
. Sie hat das Format models/{model}
.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
<ph type="x-smartling-placeholder">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 für RETRIEVAL_DOCUMENT
einen title
angeben, werden Einbettungen mit höherer Qualität für den Abruf bereitgestellt.
outputDimensionality
integer
Optional. Optionale reduzierte Dimension für die Ausgabeeinbettung. Wenn festgelegt, werden übermäßig viele Werte in der Ausgabeeinbettung vom Ende abgeschnitten. Wird seit 2024 von neueren Modellen unterstützt. Für das ältere Modell (models/embedding-001
) kann dieser Wert nicht angegeben werden.
Beispielanfrage
Python
Node.js
Antworttext
Die Antwort auf ein EmbedContentRequest
.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
embedding
object (ContentEmbedding
)
Nur Ausgabe. Die aus dem Eingabeinhalt generierte Einbettung.
JSON-Darstellung |
---|
{
"embedding": {
object ( |
Methode: models.batchEmbedContents
- Endpunkt
- Pfadparameter
- Anfragetext
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Antworttext
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Autorisierungsbereiche
- Beispielanfrage
<ph type="x-smartling-placeholder">
- </ph>
- Basic
- EmbedContentRequest
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
Generiert in einem synchronen Aufruf mehrere Einbettungen aus dem Modell anhand des Eingabetexts.
Endpunkt
<ph type="x-smartling-placeholder"></ph> Beitrag
https://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}
. Sie hat das Format models/{model}
.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
<ph type="x-smartling-placeholder">requests[]
object (EmbedContentRequest
)
Erforderlich. Einbettungsanfragen für den Batch. Das Modell in jeder dieser Anfragen muss dem in BatchEmbedContentsRequest.model
angegebenen Modell entsprechen.
Beispielanfrage
Python
Node.js
Antworttext
Die Antwort auf ein 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 Batchanfrage angegeben.
JSON-Darstellung |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
Anfrage mit der Content
für das einzubettende Modell.
JSON-Darstellung |
---|
{ "model": string, "content": { object ( |
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. Ein optionaler Titel für den Text. Gilt nur, wenn der TaskType RETRIEVAL_DOCUMENT
ist.
Hinweis: Wenn Sie für RETRIEVAL_DOCUMENT
einen title
angeben, werden Einbettungen mit höherer Qualität für den Abruf bereitgestellt.
outputDimensionality
integer
Optional. Optionale reduzierte Dimension für die Ausgabeeinbettung. Wenn festgelegt, werden übermäßig viele Werte in der Ausgabeeinbettung vom Ende abgeschnitten. Wird seit 2024 von neueren Modellen unterstützt. Für das ältere Modell (models/embedding-001
) kann dieser Wert nicht angegeben werden.
ContentEmbedding
Eine Liste von Gleitkommazahlen, die eine Einbettung darstellen.
JSON-Darstellung |
---|
{ "values": [ number ] } |
values[]
number
Die Einbettungswerte.
TaskType
Aufgabentyp, für den die Einbettung verwendet wird.
Enums | |
---|---|
TASK_TYPE_UNSPECIFIED |
Nicht festgelegter Wert, der standardmäßig auf einen der anderen enum-Werte verwendet 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 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. |