Cria incorporações vetoriais para a(s) entrada(s) de texto fornecida(s). Esse endpoint aceita uma única string de texto ou uma lista de strings de texto e retorna suas incorporações vetoriais correspondentes.
Para tarefas de pesquisa e recuperação semântica, defina o parâmetro input_type como query ou document para otimizar a forma como o modelo cria os vetores.
corpo, corpo
Obrigatório
Entrada
corda | array[string] Obrigatório Uma única string de texto ou uma lista de strings de texto a serem incorporadas, como
["I like cats", "I also like dogs"].Restrições:
- Comprimento máximo da lista: 1,000 itens
- Total máximo de tokens: 1M para
voyage-3.5-lite; 320K paravoyage-3.5evoyage-2; 120K paravoyage-3-large,voyage-code-3,voyage-finance-2evoyage-law-2
-
O modelo de incorporação a ser usado. Modelos recomendados:
voyage-3-large,voyage-3.5,voyage-3.5-lite,voyage-code-3,voyage-finance-2,voyage-law-2.Os valores são
voyage-context-3,voyage-3.5,voyage-3.5-lite,voyage-3-large,voyage-code-3,voyage-multimodal-3,voyage-finance-2,voyage-law-2ouvoyage-code-2. -
O tipo de texto de entrada. Use esse parâmetro para otimizar incorporações para tarefas de pesquisa e recuperação semânticas.
Opções:
null(padrão): o modelo converte diretamente a entrada em vetores numéricos sem nenhum prompt adicional.query: Utilize quando a entrada representa uma query de pesquisa. O modelo acrescenta "Representar a consulta para recuperar documentos de suporte: " para otimizar a incorporação para recuperação.document: Use quando a entrada representar um documento a ser pesquisado. O modelo acrescenta "Representar o documento para recuperação: " para otimizar a incorporação para recuperação.
Para tarefas de pesquisa e recuperação semântica, sempre defina este parâmetro como
queryoudocumentconforme apropriado. As incorporações geradas com e sem o argumentoinput_typesão compatíveis.Os valores
querysão,documentou nulo. -
Se deve truncar textos de entrada que excedem o comprimento do contexto.
true(padrão): os textos de entrada que excedem o comprimento do contexto são automaticamente truncados antes da vetorização.false: Um erro será retornado se algum texto de entrada exceder o comprimento do contexto.
O valor padrão é
true. -
O número de dimensões para as incorporações de saída.
A maioria dos modelos suporta apenas uma única dimensão padrão. Os modelos
voyage-3-large,voyage-3.5,voyage-3.5-liteevoyage-code-3suportam os seguintes valores: 256, 512, 1024 (padrão) e 2048.Configure para
nullpara utilizar a dimensão padrão do modelo.Os valores são,,,
25651210242048ou nulo. -
O tipo de dados para as incorporações retornadas.
Opções:
float(padrão): números de ponto flutuante de precisão única de 32bits. Fornece a mais alta precisão e exatidão de recuperação. Suportado por todos os modelos.int8: 8bits inteiros assinados variando de -128 a 127. Compatível comvoyage-3-large,voyage-3.5,voyage-3.5-liteevoyage-code-3.uint8: 8inteiros não assinados de bits, que variam de 0 a 255. Compatível comvoyage-3-large,voyage-3.5,voyage-3.5-liteevoyage-code-3.binary: Valores de incorporação de bit único quantizados e compactados em bits representados comoint8. O comprimento da lista retornado é 1/8 deoutput_dimension. Usa o método binário offset. Compatível comvoyage-3-large,voyage-3.5,voyage-3.5-liteevoyage-code-3.ubinary: Valores de incorporação de bit único quantizados e compactados em bits representados comouint8. O comprimento da lista retornado é 1/8 deoutput_dimension. Compatível comvoyage-3-large,voyage-3.5,voyage-3.5-liteevoyage-code-3.
Os valores são
float,int8,uint8,binaryouubinary. O valor padrão éfloat. -
O formato em que as incorporações são codificadas na resposta.
Opções:
null(padrão): as incorporações são retornadas como arrays. Quandooutput_dtypeéfloat, cada incorporação é uma array de números de ponto flutuante. Para outros valores deoutput_dtype(int8,uint8,binary,ubinary), cada incorporação é uma array de números inteiros.base64: as incorporações são retornadas como arrays NumPy codificadas em Base64com os seguintes tipos de dados:numpy.float32quandooutput_dtypeéfloatnumpy.int8quandooutput_dtypeéint8oubinarynumpy.uint8quandooutput_dtypeéuint8ouubinary
Os valores são
base64ou nulo.
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"
}