Metodo: models.embedContent
- Endpoint
- Parametri percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Richiesta di esempio
- .
- Basic
Genera un incorporamento dal modello una data Content
di input.
Endpoint
pubblica
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContent
Parametri del percorso
model
string
Obbligatorio. Il nome della risorsa del modello. Serve da ID per il modello.
Questo nome deve corrispondere a un nome di modello restituito dal metodo models.list
.
Formato: models/{model}
Prende il formato models/{model}
.
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
content
object (Content
)
Obbligatorio. I contenuti da incorporare. Verranno conteggiati solo i campi parts.text
.
taskType
enum (TaskType
)
(Facoltativo) Tipo di attività facoltativo per cui verranno utilizzati gli incorporamenti. Può essere impostato solo per models/embedding-001
.
title
string
(Facoltativo) Un titolo facoltativo per il testo. Applicabile solo quando il tipo di attività è RETRIEVAL_DOCUMENT
.
Nota: se specifichi un title
per RETRIEVAL_DOCUMENT
, ottieni incorporamenti di qualità migliore per il recupero.
outputDimensionality
integer
(Facoltativo) Dimensione ridotta facoltativa per l'incorporamento di output. Se questa impostazione è impostata, un numero eccessivo di valori nell'incorporamento di output viene troncato dalla fine. Supportato dai modelli più recenti dal 2024 e il modello precedente (models/embedding-001
) non può specificare questo valore.
Esempio di richiesta
Python
Node.js
Corpo della risposta
La risposta a un EmbedContentRequest
.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
embedding
object (ContentEmbedding
)
Solo output. L'incorporamento generato dai contenuti di input.
Rappresentazione JSON |
---|
{
"embedding": {
object ( |
Metodo: models.batchEmbedContents
- Endpoint
- Parametri percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Richiesta di esempio
- .
- Basic
- EmbedContentRequest
Genera più incorporamenti dal modello dato il testo di input in una chiamata sincrona.
Endpoint
pubblica
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContents
Parametri del percorso
model
string
Obbligatorio. Il nome della risorsa del modello. Serve da ID per il modello.
Questo nome deve corrispondere a un nome di modello restituito dal metodo models.list
.
Formato: models/{model}
Prende il formato models/{model}
.
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
requests[]
object (EmbedContentRequest
)
Obbligatorio. Incorpora le richieste per il batch. Il modello in ciascuna di queste richieste deve corrispondere al modello specificato per BatchEmbedContentsRequest.model
.
Esempio di richiesta
Python
Node.js
Corpo della risposta
La risposta a un BatchEmbedContentsRequest
.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
embeddings[]
object (ContentEmbedding
)
Solo output. Gli incorporamenti per ogni richiesta, nello stesso ordine fornito nella richiesta batch.
Rappresentazione JSON |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
Richiesta contenente Content
per il modello da incorporare.
Rappresentazione JSON |
---|
{ "model": string, "content": { object ( |
model
string
Obbligatorio. Il nome della risorsa del modello. Serve da ID per il modello.
Questo nome deve corrispondere a un nome di modello restituito dal metodo models.list
.
Formato: models/{model}
content
object (Content
)
Obbligatorio. I contenuti da incorporare. Verranno conteggiati solo i campi parts.text
.
taskType
enum (TaskType
)
(Facoltativo) Tipo di attività facoltativo per cui verranno utilizzati gli incorporamenti. Può essere impostato solo per models/embedding-001
.
title
string
(Facoltativo) Un titolo facoltativo per il testo. Applicabile solo quando il tipo di attività è RETRIEVAL_DOCUMENT
.
Nota: se specifichi un title
per RETRIEVAL_DOCUMENT
, ottieni incorporamenti di qualità migliore per il recupero.
outputDimensionality
integer
(Facoltativo) Dimensione ridotta facoltativa per l'incorporamento di output. Se questa impostazione è impostata, un numero eccessivo di valori nell'incorporamento di output viene troncato dalla fine. Supportato dai modelli più recenti dal 2024 e il modello precedente (models/embedding-001
) non può specificare questo valore.
ContentEmbedding
Un elenco di numeri in virgola mobile che rappresentano un incorporamento.
Rappresentazione JSON |
---|
{ "values": [ number ] } |
values[]
number
I valori di incorporamento.
TaskType
Tipo di attività per cui verrà utilizzato l'incorporamento.
Enum | |
---|---|
TASK_TYPE_UNSPECIFIED |
Valore non impostato, che verrà impostato in modo predefinito su uno degli altri valori enum. |
RETRIEVAL_QUERY |
Specifica che il testo specificato è una query in un'impostazione di ricerca/recupero. |
RETRIEVAL_DOCUMENT |
Specifica che il testo specificato è un documento del corpus in cui viene eseguita la ricerca. |
SEMANTIC_SIMILARITY |
Specifica il testo specificato che verrà utilizzato per STS. |
CLASSIFICATION |
Specifica che il testo specificato verrà classificato. |
CLUSTERING |
Specifica che gli incorporamenti verranno utilizzati per il clustering. |
QUESTION_ANSWERING |
Specifica che il testo specificato verrà utilizzato per la risposta alle domande. |
FACT_VERIFICATION |
Specifica che il testo specificato verrà utilizzato per la verifica dei fatti. |