Method: models.embedContent

Genera una incorporación a partir del modelo a partir de un Content de entrada.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
model

string

Obligatorio. El nombre del recurso del modelo. Esto sirve como un ID para que el modelo lo use.

Este nombre debe coincidir con un nombre de modelo que muestre el método models.list.

Formato: models/{model}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
Campos
content

object (Content)

Obligatorio. El contenido que se va a incorporar Solo se contarán los parts.text campos.

taskType

enum (TaskType)

Opcional. Tipo de tarea opcional para el que se usarán las incorporaciones. Solo se puede configurar para models/embedding-001.

title

string

Opcional. Es un título opcional para el texto. Solo se aplica cuando TaskType es RETRIEVAL_DOCUMENT.

Nota: Especificar un title para RETRIEVAL_DOCUMENT proporciona incorporaciones de mejor calidad para la recuperación.

outputDimensionality

integer

Opcional. Dimensión reducida opcional para la incorporación de la salida. Si se configura, los valores excesivos en la incorporación de salida se truncan desde el final. Es compatible con modelos más recientes desde 2024 y el modelo anterior (models/embedding-001) no puede especificar este valor.

Cuerpo de la respuesta

Es la respuesta a un elemento EmbedContentRequest.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "embedding": {
    object (ContentEmbedding)
  }
}
Campos
embedding

object (ContentEmbedding)

Solo salida. La incorporación generada a partir del contenido de entrada.

Permisos de autorización

Se necesita uno de los siguientes alcances 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 obtener más información, consulta Descripción general de la autenticación.