Embeddings

Los embeddings son una representación numérica de la entrada de texto que permite una serie de casos de uso únicos, como el agrupamiento en clústeres, la medición de la similitud y la recuperación de información. Para obtener una introducción, consulta la guía de incorporaciones.

A diferencia de los modelos de IA generativa que crean contenido nuevo, el modelo de Gemini Embedding solo está diseñado para transformar el formato de tus datos de entrada en una representación numérica. Si bien Google es responsable de proporcionar un modelo de incorporación que transforme el formato de tus datos de entrada al formato numérico solicitado, los usuarios siguen siendo totalmente responsables de los datos que ingresan y de las incorporaciones resultantes. Si utilizas el modelo de Gemini Embedding, confirmas que tienes los derechos necesarios sobre cualquier contenido que subas. No generes contenido que infrinja la propiedad intelectual o los derechos de privacidad de otras personas. El uso de este servicio está sujeto a nuestra Política de Uso Prohibido y a las Condiciones del Servicio de Google.

Método: models.embedContent

Genera un vector de incorporación de texto a partir del Content de entrada con el modelo de incorporación de Gemini especificado.

Extremo

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

Parámetros de ruta

model string

Obligatorio. Es el nombre del recurso del modelo. Este valor sirve como ID para que lo use el modelo.

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

Formato: models/{model}. Toma la forma models/{model}.

Cuerpo de la solicitud

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

Campos
content object (Content)

Obligatorio. Es el contenido que se incorporará. Solo se contarán los campos parts.text.

taskType enum (TaskType)

Opcional. Es el tipo de tarea opcional para el que se usarán los embeddings. No es compatible con modelos anteriores (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 el embedding de salida. Si se establece, los valores excesivos en el embedding de salida se truncan desde el final. Solo es compatible con los modelos más recientes desde 2024. No puedes establecer este valor si usas el modelo anterior (models/embedding-001).

Ejemplo de solicitud

Python

from google import genai
from google.genai import types

client = genai.Client()
text = "Hello World!"
result = client.models.embed_content(
    model="gemini-embedding-001",
    contents=text,
    config=types.EmbedContentConfig(output_dimensionality=10),
)
print(result.embeddings)

Node.js

// Make sure to include the following import:
// import {GoogleGenAI} from '@google/genai';
const ai = new GoogleGenAI({ apiKey: process.env.GEMINI_API_KEY });
const text = "Hello World!";
const result = await ai.models.embedContent({
  model: "gemini-embedding-001",
  contents: text,
  config: { outputDimensionality: 10 },
});
console.log(result.embeddings);

Go

ctx := context.Background()
client, err := genai.NewClient(ctx, &genai.ClientConfig{
	APIKey:  os.Getenv("GEMINI_API_KEY"),
	Backend: genai.BackendGeminiAPI,
})
if err != nil {
	log.Fatal(err)
}

text := "Hello World!"
outputDim := int32(10)
contents := []*genai.Content{
	genai.NewContentFromText(text, genai.RoleUser),
}
result, err := client.Models.EmbedContent(ctx, "gemini-embedding-001", 
	contents, &genai.EmbedContentConfig{
		OutputDimensionality: &outputDim,
})
if err != nil {
	log.Fatal(err)
}

embeddings, err := json.MarshalIndent(result.Embeddings, "", "  ")
if err != nil {
	log.Fatal(err)
}
fmt.Println(string(embeddings))

Almeja

curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-embedding-001:embedContent" \
-H "x-goog-api-key: $GEMINI_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"model": "models/gemini-embedding-001",
     "content": {
     "parts":[{
     "text": "What is the meaning of life?"}]}
    }'

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de EmbedContentResponse.

Método: models.batchEmbedContents

Genera varios vectores de incorporación a partir del Content de entrada, que consta de un lote de cadenas representadas como objetos EmbedContentRequest.

Extremo

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

Parámetros de ruta

model string

Obligatorio. Es el nombre del recurso del modelo. Este valor sirve como ID para que lo use el modelo.

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

Formato: models/{model}. Toma la forma models/{model}.

Cuerpo de la solicitud

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

Campos
requests[] object (EmbedContentRequest)

Obligatorio. Son las solicitudes de incorporación para el lote. El modelo en cada una de estas solicitudes debe coincidir con el modelo especificado BatchEmbedContentsRequest.model.

Ejemplo de solicitud

Python

from google import genai
from google.genai import types

client = genai.Client()
texts = [
    "What is the meaning of life?",
    "How much wood would a woodchuck chuck?",
    "How does the brain work?",
]
result = client.models.embed_content(
    model="gemini-embedding-001",
    contents=texts,
    config=types.EmbedContentConfig(output_dimensionality=10),
)
print(result.embeddings)

Node.js

// Make sure to include the following import:
// import {GoogleGenAI} from '@google/genai';
const ai = new GoogleGenAI({ apiKey: process.env.GEMINI_API_KEY });
const texts = [
  "What is the meaning of life?",
  "How much wood would a woodchuck chuck?",
  "How does the brain work?",
];
const result = await ai.models.embedContent({
  model: "gemini-embedding-001",
  contents: texts,
  config: { outputDimensionality: 10 },
});
console.log(result.embeddings);

Go

ctx := context.Background()
client, err := genai.NewClient(ctx, &genai.ClientConfig{
	APIKey:  os.Getenv("GEMINI_API_KEY"),
	Backend: genai.BackendGeminiAPI,
})
if err != nil {
	log.Fatal(err)
}

contents := []*genai.Content{
	genai.NewContentFromText("What is the meaning of life?", genai.RoleUser),
	genai.NewContentFromText("How much wood would a woodchuck chuck?", genai.RoleUser),
	genai.NewContentFromText("How does the brain work?", genai.RoleUser),
}

outputDim := int32(10)
result, err := client.Models.EmbedContent(ctx, "gemini-embedding-001", contents, &genai.EmbedContentConfig{
	OutputDimensionality: &outputDim,
})
if err != nil {
	log.Fatal(err)
}

embeddings, err := json.MarshalIndent(result.Embeddings, "", "  ")
if err != nil {
	log.Fatal(err)
}
fmt.Println(string(embeddings))

Almeja

curl "https://generativelanguage.googleapis.com/v1beta/models/gemini-embedding-001:batchEmbedContents" \
-H "x-goog-api-key: $GEMINI_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"requests": [{
      "model": "models/gemini-embedding-001",
      "content": {
      "parts":[{
        "text": "What is the meaning of life?"}]}, },
      {
      "model": "models/gemini-embedding-001",
      "content": {
      "parts":[{
        "text": "How much wood would a woodchuck chuck?"}]}, },
      {
      "model": "models/gemini-embedding-001",
      "content": {
      "parts":[{
        "text": "How does the brain work?"}]}, }, ]}' 2> /dev/null | grep -C 5 values

Cuerpo de la respuesta

Es la respuesta a un BatchEmbedContentsRequest.

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

Campos
embeddings[] object (ContentEmbedding)

Solo salida. Son las incorporaciones para cada solicitud, en el mismo orden en que se proporcionaron en la solicitud por lotes.

Representación JSON
{
  "embeddings": [
    {
      object (ContentEmbedding)
    }
  ]
}

Método: models.asyncBatchEmbedContent

Pone en cola un lote de solicitudes de models.embedContent para el procesamiento por lotes. Tenemos un controlador models.batchEmbedContents en GenerativeService, pero se sincronizó. Por lo tanto, le asignamos el nombre Async para evitar confusiones.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:asyncBatchEmbedContent

Parámetros de ruta

batch.model string

Obligatorio. Es el nombre del Model que se usará para generar la finalización.

Formato: models/{model}. Toma la forma models/{model}.

Cuerpo de la solicitud

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

Campos
batch.name string

Solo salida. Es el identificador. Es el nombre del recurso del lote.

Formato: batches/{batchId}.

batch.displayName string

Obligatorio. Es el nombre definido por el usuario de este lote.

batch.inputConfig object (InputEmbedContentConfig)

Obligatorio. Es la configuración de entrada de las instancias en las que se realiza el procesamiento por lotes.

batch.output object (EmbedContentBatchOutput)

Solo salida. Es el resultado de la solicitud por lotes.

batch.createTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó el lote.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se completó el procesamiento por lotes.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizó el lote por última vez.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batch.batchStats object (EmbedContentBatchStats)

Solo salida. Son las estadísticas sobre el lote.

batch.state enum (BatchState)

Solo salida. Es el estado del lote.

batch.priority string (int64 format)

Opcional. Es la prioridad del lote. Los lotes con un valor de prioridad más alto se procesarán antes que los lotes con un valor de prioridad más bajo. Se permiten valores negativos. El valor predeterminado es 0.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

EmbedContentRequest

Solicitud que contiene el Content para que el modelo lo incorpore.

Campos
model string

Obligatorio. Es el nombre del recurso del modelo. Este valor sirve como ID para que lo use el modelo.

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

Formato: models/{model}

content object (Content)

Obligatorio. Es el contenido que se incorporará. Solo se contarán los campos parts.text.

taskType enum (TaskType)

Opcional. Es el tipo de tarea opcional para el que se usarán los embeddings. No es compatible con modelos anteriores (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 el embedding de salida. Si se establece, los valores excesivos en el embedding de salida se truncan desde el final. Solo es compatible con los modelos más recientes desde 2024. No puedes establecer este valor si usas el modelo anterior (models/embedding-001).

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

EmbedContentResponse

Es la respuesta a un EmbedContentRequest.

Campos
embedding object (ContentEmbedding)

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

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

ContentEmbedding

Es una lista de números de punto flotante que representan una incorporación.

Campos
values[] number

Son los valores de la incorporación.

Representación JSON
{
  "values": [
    number
  ]
}

TaskType

Es el tipo de tarea para la que se usará la incorporación.

Enumeraciones
TASK_TYPE_UNSPECIFIED Es un valor no establecido que se establecerá de forma predeterminada en uno de los otros valores de enumeración.
RETRIEVAL_QUERY Especifica que el texto dado es una consulta en un parámetro de configuración de búsqueda/recuperación.
RETRIEVAL_DOCUMENT Especifica que el texto dado es un documento del corpus en el que se realiza la búsqueda.
SEMANTIC_SIMILARITY Especifica que el texto dado se usará para la STS.
CLASSIFICATION Especifica que se clasificará el texto determinado.
CLUSTERING Especifica que las incorporaciones se usarán para el agrupamiento en clústeres.
QUESTION_ANSWERING Especifica que el texto proporcionado se usará para responder preguntas.
FACT_VERIFICATION Especifica que el texto proporcionado se usará para la verificación de datos.
CODE_RETRIEVAL_QUERY Especifica que el texto proporcionado se usará para la recuperación de código.

EmbedContentBatch

Es un recurso que representa un lote de solicitudes de EmbedContent.

Campos
model string

Obligatorio. Es el nombre del Model que se usará para generar la finalización.

Formato: models/{model}.

name string

Solo salida. Es el identificador. Es el nombre del recurso del lote.

Formato: batches/{batchId}.

displayName string

Obligatorio. Es el nombre definido por el usuario de este lote.

inputConfig object (InputEmbedContentConfig)

Obligatorio. Es la configuración de entrada de las instancias en las que se realiza el procesamiento por lotes.

output object (EmbedContentBatchOutput)

Solo salida. Es el resultado de la solicitud por lotes.

createTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó el lote.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Solo salida. Es la fecha y hora en que se completó el procesamiento por lotes.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizó el lote por última vez.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

batchStats object (EmbedContentBatchStats)

Solo salida. Son las estadísticas sobre el lote.

state enum (BatchState)

Solo salida. Es el estado del lote.

priority string (int64 format)

Opcional. Es la prioridad del lote. Los lotes con un valor de prioridad más alto se procesarán antes que los lotes con un valor de prioridad más bajo. Se permiten valores negativos. El valor predeterminado es 0.

Representación JSON
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputEmbedContentConfig)
  },
  "output": {
    object (EmbedContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (EmbedContentBatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputEmbedContentConfig

Configura la entrada de la solicitud por lotes.

Campos
source Union type
Obligatorio. Es la fuente de la entrada. source puede ser una de las siguientes opciones:
fileName string

Nombre del File que contiene las solicitudes de entrada.

requests object (InlinedEmbedContentRequests)

Son las solicitudes que se procesarán en el lote.

Representación JSON
{

  // source
  "fileName": string,
  "requests": {
    object (InlinedEmbedContentRequests)
  }
  // Union type
}

InlinedEmbedContentRequests

Son las solicitudes que se procesarán en el lote si se proporcionan como parte de la solicitud de creación del lote.

Campos
requests[] object (InlinedEmbedContentRequest)

Obligatorio. Son las solicitudes que se procesarán en el lote.

Representación JSON
{
  "requests": [
    {
      object (InlinedEmbedContentRequest)
    }
  ]
}

InlinedEmbedContentRequest

Es la solicitud que se procesará en el lote.

Campos
request object (EmbedContentRequest)

Obligatorio. Es la solicitud que se procesará en el lote.

metadata object (Struct format)

Opcional. Son los metadatos que se asociarán con la solicitud.

Representación JSON
{
  "request": {
    object (EmbedContentRequest)
  },
  "metadata": {
    object
  }
}

EmbedContentBatchOutput

Es el resultado de una solicitud por lotes. Se devuelve en el campo AsyncBatchEmbedContentResponse o EmbedContentBatch.output.

Campos
output Union type
Es el resultado de la solicitud por lotes. output puede ser una de las siguientes opciones:
responsesFile string

Solo salida. Es el ID del archivo que contiene las respuestas. El archivo será un archivo JSONL con una sola respuesta por línea. Las respuestas serán mensajes EmbedContentResponse con formato JSON. Las respuestas se escribirán en el mismo orden que las solicitudes de entrada.

inlinedResponses object (InlinedEmbedContentResponses)

Solo salida. Son las respuestas a las solicitudes del lote. Se devuelve cuando el lote se compiló con solicitudes intercaladas. Las respuestas estarán en el mismo orden que las solicitudes de entrada.

Representación JSON
{

  // output
  "responsesFile": string,
  "inlinedResponses": {
    object (InlinedEmbedContentResponses)
  }
  // Union type
}

InlinedEmbedContentResponses

Son las respuestas a las solicitudes del lote.

Campos
inlinedResponses[] object (InlinedEmbedContentResponse)

Solo salida. Son las respuestas a las solicitudes del lote.

Representación JSON
{
  "inlinedResponses": [
    {
      object (InlinedEmbedContentResponse)
    }
  ]
}

InlinedEmbedContentResponse

Es la respuesta a una sola solicitud del lote.

Campos
metadata object (Struct format)

Solo salida. Son los metadatos asociados a la solicitud.

output Union type
Es el resultado de la solicitud. output puede ser una de las siguientes opciones:
error object (Status)

Solo salida. Es el error que se produjo mientras se procesaba la solicitud.

response object (EmbedContentResponse)

Solo salida. Es la respuesta a la solicitud.

Representación JSON
{
  "metadata": {
    object
  },

  // output
  "error": {
    object (Status)
  },
  "response": {
    object (EmbedContentResponse)
  }
  // Union type
}

EmbedContentBatchStats

Son las estadísticas sobre el lote.

Campos
requestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes en el lote.

successfulRequestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes que se procesaron correctamente.

failedRequestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes que no se pudieron procesar.

pendingRequestCount string (int64 format)

Solo salida. Es la cantidad de solicitudes que aún están pendientes de procesamiento.

Representación JSON
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}