Method: models.batchEmbedContents

Gera vários embeddings do modelo com base no texto de entrada em uma chamada síncrona.

Solicitação HTTP

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

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 
{
  "requests": [
    {
      object (EmbedContentRequest)
    }
  ]
}
Campos
requests[]

object (EmbedContentRequest)

Obrigatório. Incorporar solicitações para o lote. O modelo em cada uma dessas solicitações precisa corresponder ao modelo especificado BatchEmbedContentsRequest.model.

Corpo da resposta

A resposta a uma BatchEmbedContentsRequest.

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

Representação JSON 
{
  "embeddings": [
    {
      object (ContentEmbedding)
    }
  ]
}
Campos
embeddings[]

object (ContentEmbedding)

Apenas saída. Os embeddings de cada solicitação, na mesma ordem fornecida na solicitação em lote.

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.

EmbedContentRequest

Solicitação contendo o Content para o modelo incorporar.

Representação JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
Campos
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}
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.