Las incorporaciones son una representación numérica de la entrada de texto que abre varios casos de uso únicos, como el agrupamiento en clústeres, la medición de similitudes y la recuperación de información. Para ver una introducción, consulta la Guía de incorporaciones.
Método: models.embedContent
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
Genera un vector de incorporación de texto a partir del Content
de entrada con el modelo de incorporación de Gemini especificado.
Extremo
publicación
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContent
Parámetros de ruta
model
string
Obligatorio. El nombre del recurso del modelo. Esto sirve como un ID para que use el modelo.
Este nombre debe coincidir con el nombre de modelo que muestra 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:
content
object (Content
)
Obligatorio. El contenido que se incorporará. Solo se contarán los parts.text
campos.
taskType
enum (TaskType
)
Opcional. Tipo de tarea opcional para la que se usarán las incorporaciones. Solo se puede establecer 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 su recuperación.
outputDimensionality
integer
Opcional. Es una dimensión reducida opcional para la incorporación de salida. Si se establece, los valores excesivos en la incorporación de salida se truncan desde el final. Solo es compatible con los modelos más nuevos desde 2024. No puedes establecer este valor si usas el modelo anterior (models/embedding-001
).
Ejemplo de solicitud
Python
Node.js
Una caracola
Cuerpo de la respuesta
Es la respuesta a un EmbedContentRequest
.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
embedding
object (ContentEmbedding
)
Solo salida. La incorporación generada a partir del contenido de entrada.
Representación JSON |
---|
{
"embedding": {
object ( |
Método: models.batchEmbedContents
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
- EmbedContentRequest
Genera varios vectores de incorporación a partir del Content
de entrada, que consiste en un lote de cadenas representadas como objetos EmbedContentRequest
.
Extremo
publicación
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContents
Parámetros de ruta
model
string
Obligatorio. El nombre del recurso del modelo. Esto sirve como un ID para que use el modelo.
Este nombre debe coincidir con el nombre de modelo que muestra 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:
requests[]
object (EmbedContentRequest
)
Obligatorio. Incorporar solicitudes para el lote El modelo de cada una de estas solicitudes debe coincidir con el modelo especificado BatchEmbedContentsRequest.model
.
Ejemplo de solicitud
Python
Node.js
Una caracola
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:
embeddings[]
object (ContentEmbedding
)
Solo salida. Las incorporaciones para cada solicitud, en el mismo orden que se proporcionó en la solicitud por lotes.
Representación JSON |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
Solicitud que contiene el Content
para que el modelo lo incorpore.
model
string
Obligatorio. El nombre del recurso del modelo. Esto sirve como un ID para que use el modelo.
Este nombre debe coincidir con el nombre de modelo que muestra el método models.list
.
Formato: models/{model}
content
object (Content
)
Obligatorio. El contenido que se incorporará. Solo se contarán los parts.text
campos.
taskType
enum (TaskType
)
Opcional. Tipo de tarea opcional para la que se usarán las incorporaciones. Solo se puede establecer 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 su recuperación.
outputDimensionality
integer
Opcional. Es una dimensión reducida opcional para la incorporación de salida. Si se establece, los valores excesivos en la incorporación de salida se truncan desde el final. Solo es compatible con los modelos más nuevos desde 2024. No puedes establecer este valor si usas el modelo anterior (models/embedding-001
).
ContentEmbedding
Una lista de números de punto flotante que representan una incorporación.
values[]
number
Los valores de incorporación.
Representación JSON |
---|
{ "values": [ number ] } |
TaskType
Tipo de tarea para la que se usará la incorporación.
Enumeraciones | |
---|---|
TASK_TYPE_UNSPECIFIED |
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 que se está buscando. |
SEMANTIC_SIMILARITY |
Especifica que el texto dado se usará para STS. |
CLASSIFICATION |
Especifica que se clasificará el texto proporcionado. |
CLUSTERING |
Especifica que las incorporaciones se usarán para el agrupamiento en clústeres. |
QUESTION_ANSWERING |
Especifica que el texto dado se utilizará para responder preguntas. |
FACT_VERIFICATION |
Especifica que el texto proporcionado se utilizará para la verificación de datos. |