Method: models.embedContent

Genera un incorporamento dal modello a cui è stato assegnato un input Content.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
model

string

Obbligatoria. Il nome della risorsa del modello. che funge da ID per il modello.

Questo nome deve corrispondere a un nome di modello restituito dal metodo models.list.

Formato: models/{model}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
Campi
content

object (Content)

Obbligatoria. I contenuti da incorporare. Verranno conteggiati solo i campi parts.text.

taskType

enum (TaskType)

Campo facoltativo. Tipo di attività facoltativa per cui verranno utilizzati gli incorporamenti. Può essere impostato solo per models/embedding-001.

title

string

Campo facoltativo. Un titolo facoltativo per il testo. Applicabile solo quando TaskType è RETRIEVAL_DOCUMENT.

Nota: l'indicazione di un title per RETRIEVAL_DOCUMENT fornisce incorporamenti di qualità migliore per il recupero.

outputDimensionality

integer

Campo facoltativo. Dimensione ridotta facoltativa per l'incorporamento dell'output. Se impostato, i valori eccessivi nell'incorporamento dell'output vengono troncati dalla fine. Questo valore è supportato dai modelli più recenti dal 2024 e il modello precedente (models/embedding-001) non può specificare questo valore.

Corpo della risposta

La risposta a un EmbedContentRequest.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "embedding": {
    object (ContentEmbedding)
  }
}
Campi
embedding

object (ContentEmbedding)

Solo output. L'incorporamento generato dai contenuti di input.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • 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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.