Method: models.embedContent

Gera um embedding do modelo com base em uma entrada Content.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
model

string

Obrigatório. O nome do recurso do modelo. Isso serve como um ID a ser usado pelo modelo.

Esse nome precisa corresponder ao nome de um modelo retornado pelo método models.list.

Formato: models/{model}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
Campos
content

object (Content)

Obrigatório. O conteúdo a ser incorporado. Somente os campos parts.text serão contados.

taskType

enum (TaskType)

Opcional. Tipo de tarefa opcional em que os embeddings serão usados. Só pode ser definido para models/embedding-001.

title

string

Opcional. Um título opcional para o texto. Aplicável apenas quando o TaskType é RETRIEVAL_DOCUMENT.

Observação: especificar um title para RETRIEVAL_DOCUMENT fornece embeddings de melhor qualidade para recuperação.

outputDimensionality

integer

Opcional. Dimensão reduzida opcional para o embedding de saída. Se definido, os valores em excesso no embedding de saída serão truncados no final. Com suporte nos modelos mais recentes desde 2024, e o modelo anterior (models/embedding-001) não pode especificar esse valor.

Corpo da resposta

A resposta a uma EmbedContentRequest.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "embedding": {
    object (ContentEmbedding)
  }
}
Campos
embedding

object (ContentEmbedding)

Apenas saída. O embedding gerado a partir do conteúdo de entrada.

Escopos de autorização

Requer um dos seguintes escopos de 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

Para saber mais, consulte a Visão geral da autenticação.