Crea incrustaciones vectoriales para las entradas de texto proporcionadas. Este punto final acepta una sola cadena de texto o una lista de cadenas de texto y devuelve sus incrustaciones vectoriales correspondientes.
Para tareas de búsqueda semántica y recuperación, establece el parámetro input_type a query o document para optimizar cómo el modelo crea los vectores.
Cuerpo
Requerido
entrada
string | arreglo[string] Requerido Una única string de texto o una lista de strings de texto que se insertarán, como
["I like cats", "I also like dogs"].Restricciones:
- Longitud máxima de la lista: 1,000 elementos
- Máximo total de tokens: 1M para
voyage-3.5-liteyvoyage-4-lite; 320K paravoyage-3.5,voyage-4yvoyage-2; 120K paravoyage-3-large,voyage-4-large,voyage-code-3,voyage-finance-2yvoyage-law-2.
-
El modelo de embedding a utilizar. Modelos recomendados:
voyage-4-large,voyage-4,voyage-4-lite,voyage-code-3,voyage-finance-2,voyage-law-2.Los valores son
voyage-context-3,voyage-4,voyage-4-lite,voyage-4-large,voyage-3.5,voyage-3.5-lite,voyage-3-large,voyage-code-3,voyage-multimodal-3,voyage-finance-2,voyage-law-2ovoyage-code-2. -
El tipo de texto de entrada. Utiliza este parámetro para optimizar los embeddings para tareas de búsqueda y recuperación semántica.
Opciones:
null(por defecto): El modelo convierte directamente la entrada en vectores numéricos sin ningún mensaje adicional.query: Úselo cuando la entrada represente una consulta de búsqueda. El modelo antepone "Representa la query para la recuperación de documentos de respaldo: " para optimizar la incrustación para la recuperación.documentUse cuando la entrada representa un documento para buscar. El modelo antepone "Representar el documento para su recuperación: " para optimizar la incrustación para la recuperación.
Para tareas de búsqueda y recuperación semántica, siempre establece este parámetro en
queryodocument, según corresponda. Los embedding generados con y sin el argumentoinput_typeson compatibles.Los valores son
query,documento null. -
Si se truncarán los textos de entrada que excedan la longitud del contexto.
true(por defecto): Los textos de entrada que exceden la longitud del contexto se truncan automáticamente antes de la vectorización.false: Se retorna un error si cualquier texto de entrada excede la longitud del contexto.
El valor por defecto es
true. -
El número de dimensiones para las incrustaciones de salida.
La mayoría de los modelos admiten únicamente una dimensión por defecto. Los modelos
voyage-4-large,voyage-4,voyage-4-lite,voyage-3-large,voyage-3.5,voyage-3.5-liteyvoyage-code-3soportan los siguientes valores: 256, 512, 1024 (por defecto) y 2048.Configura en
nullpara usar la dimensión por defecto del modelo.Los valores son,,,
25651210242048o nulo. -
El tipo de datos para los incrustaciones devueltos.
Opciones:
float(por defecto): números de coma flotante de precisión simple de 32bits. Proporciona la máxima precisión y exactitud en la recuperación de información. Compatibles con todos los modelos.int8Enteros con signo de 8bits, de -128 a 127. Compatible convoyage-4-large,voyage-4,voyage-4-lite,voyage-3-large,voyage-3.5,voyage-3.5-liteyvoyage-code-3.uint8: enteros sin signo de 8bits con un rango de 0 a 255. Compatible convoyage-4-large,voyage-4,voyage-4-lite,voyage-3-large,voyage-3.5,voyage-3.5-liteyvoyage-code-3.binaryValores de incrustación de un solo bit empaquetados en bits y cuantificados representados comoint8. La longitud de la lista devuelta es 1/8 deoutput_dimension. Utiliza el método binario de desplazamiento. Compatible convoyage-4-large,voyage-4,voyage-4-lite,voyage-3-large,voyage-3.5,voyage-3.5-liteyvoyage-code-3.ubinaryValores de incrustación de un solo bit empaquetados en bits y cuantificados representados comouint8. La longitud de la lista devuelta es 1/8 deoutput_dimension. Soportado porvoyage-4-large,voyage-4,voyage-4-lite,voyage-3-large,voyage-3.5,voyage-3.5-liteyvoyage-code-3.
Los valores son
float,int8,uint8,binaryoubinary. El valor predeterminado esfloat. -
El formato en el que se codifican las incrustaciones en la respuesta.
Opciones:
null(Predeterminado): Las incrustaciones se devuelven como matrices. Cuandooutput_dtypeesfloat, cada incrustación es una matriz de números de punto flotante. Para otros valoresoutput_dtype(int8,uint8,binary,ubinary), cada incrustación es una matriz de enteros.base64Los embeddings se devuelven como arreglos NumPy codificados en Base64, con los siguientes tipos de datos:numpy.float32cuandooutput_dtypeesfloatnumpy.int8cuandooutput_dtypeesint8obinarynumpy.uint8cuandooutput_dtypeesuint8oubinary
Los valores son
base64o nulos.
curl \
--request POST 'https://ai.mongodb.com/v1/embeddings' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"input":"string","model":"voyage-context-3","input_type":"query","truncation":true,"output_dimension":256,"output_dtype":"float","encoding_format":"base64"}'
{
"input": "string",
"model": "voyage-context-3",
"input_type": "query",
"truncation": true,
"output_dimension": 256,
"output_dtype": "float",
"encoding_format": "base64"
}
{
"object": "list",
"data": [
{
"object": "embedding",
"embedding": [
42.0
],
"index": 42
}
],
"model": "string",
"usage": {
"total_tokens": 42
}
}
{
"detail": "string"
}
{
"detail": "string"
}
{
"detail": "string"
}
{
"detail": "string"
}
{
"detail": "string"
}
{
"detail": "string"
}
{
"detail": "string"
}
{
"detail": "string"
}