Acessando os modelos de IA do Voyage

Chaves de API

A Embedding and Reranking API usa chaves de API para monitorar o uso e gerenciar permissões. Para criar e gerenciar suas chaves de API de modelo, use a IU do MongoDB Atlas. Para obter instruções, consulte gerenciar Voyage AI Model API Keys.

REST API

Os exemplos a seguir demonstram como chamar o serviço de embedding por meio da REST API. A API oferece suporte a solicitações cURL e HTTP de qualquer linguagem de programação.

A autenticação é tratada por meio da chave de API do modelo, que você deve incluir no cabeçalho de autorização de cada solicitação de API como um token de portador.

Para saber mais, consulte a especificação completa da API.

https://eu.ai.mongodb.com/v1/embeddings

Cliente Python

Para instalar o pacote oficial do Python usando o pip:

pip install --upgrade voyageai

Use a opção --upgrade ou -U para instalar a versão mais recente do pacote. Isso lhe dá acesso aos recursos e correções de bugs mais recentes. Para parâmetros específicos do modelo, consulte os exemplos de uso para cada página de modelo.

A classe voyageai.Client fornece uma interface síncrona para invocar a API do Voyage. Crie um objeto de cliente e use-o para acessar os modelos de IA do Voyage.

import voyageai
# Initialize the client with custom settings
vo = voyageai.Client(
    api_key="<model-api-key>",  # Or use VOYAGE_API_KEY environment variable
    max_retries=3,              # Retry up to 3 times on rate limit errors
    timeout=30                  # Timeout after 30 seconds
)
# Generate embeddings
result = vo.embed(
    texts=["MongoDB is redefining what a database is in the AI era."],
    model="voyage-4-large"
)
print(f"Embedding dimension: {len(result.embeddings[0])}")
print(f"Total tokens used: {result.total_tokens}")

A tabela a seguir descreve os parâmetros que você pode passar ao inicializar o cliente:

TypeScript cliente

Para instalar o pacote oficial do TypeScript usando npm:

npm install voyageai

A classe VoyageAIClient fornece uma interface assíncrona para invocar a API do Voyage a partir de aplicativos TypeScript e JavaScript. Crie um objeto de cliente e use-o para acessar os modelos de IA do Voyage.

Ao contrário do cliente Python, o cliente TypeScript envia solicitações para o ponto de extremidade da plataforma Voyage (https://api.voyageai.com/v1) por padrão. Para usar a API de incorporação e reclassificação com sua chave de API de modelo, defina a opção environment como https://ai.mongodb.com/v1 ao criar o cliente.

import { VoyageAIClient } from "voyageai";
// Initialize the client for the Embedding and Reranking API
const client = new VoyageAIClient({
  apiKey: process.env.VOYAGE_API_KEY,     // Model API key
  environment: "https://ai.mongodb.com/v1",
  maxRetries: 3,                          // Retry up to 3 times
  timeoutInSeconds: 30                    // Time out after 30 seconds
});
// Generate embeddings
const result = await client.embed({
  input: ["MongoDB is redefining what a database is in the AI era."],
  model: "voyage-4-large"
});
console.log(`Embedding dimension: ${result.data[0].embedding.length}`);
console.log(`Total tokens used: ${result.usage.totalTokens}`);

A tabela a seguir descreve as opções que você pode passar ao inicializar o cliente:

Além embed do, o cliente fornece os rerank multimodalEmbed contextualizedEmbed métodos, e. Para parâmetros específicos do modelo, consulte os exemplos de uso para cada página de modelo.