Acceso a los modelos de IA de Voyage

Claves de API

La Embedding and Reranking API utiliza claves de API para supervisar el uso y gestionar los permisos. Para crear y gestionar las claves de API de su modelo, utilice la interfaz de usuario de MongoDB Atlas. Para obtener instrucciones, consulte Gestionar claves de API del modelo Voyage AI.

REST API

Los siguientes ejemplos demuestran cómo llamar al servicio de incrustación a través de la REST API. La API admite solicitudes cURL y HTTP desde cualquier lenguaje de programación.

La autenticación se maneja a través de la Clave API del modelo, que debe incluir en el encabezado de autorización de cada solicitud de API como un token Bearer.

Para obtener más información, consulte la especificación completa de la API.

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

Cliente de Python

Para instalar el paquete oficial de Python usando pip:

pip install --upgrade voyageai

Utiliza la opción --upgrade o -U para instalar la versión más reciente del paquete. Esto te dará acceso a las funcionalidades más recientes y a la corrección de errores. Para obtener parámetros específicos del modelo, consulta los ejemplos de uso para cada página del modelo.

La clase voyageai.Client proporciona una interfaz síncrona para invocar la API de Voyage. Crea un objeto cliente y úsalo para acceder a modelos de IA de 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}")

La siguiente tabla describe los parámetros que se pueden pasar al inicializar el cliente:

TypeScript cliente

Para instalar el paquete oficial de Typescript usando npm:

npm install voyageai

La clase VoyageAIClient proporciona una interfaz asíncrona para invocar la API de Voyage desde aplicaciones TypeScript y JavaScript. Crea un objeto cliente y úsalo para acceder a los modelos de IA de Voyage.

A diferencia del cliente Python, el cliente TypeScript envía solicitudes al punto final de la plataforma Voyagehttps://api.voyageai.com/v1 () de forma predeterminada. Para usar la API de incrustación y reclasificación con la clave API de su modelo, cambie la environment opción a https://ai.mongodb.com/v1 al crear el 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}`);

La siguiente tabla describe las opciones que puede pasar al inicializar el cliente:

Además embed de, el cliente proporciona los rerank multimodalEmbed contextualizedEmbed métodos, y. Para ver los parámetros específicos del modelo, consulte los ejemplos de uso en la página de cada modelo.