Puede acceder a los modelos de Voyage AI mediante la API de Integración y Reclasificación, disponible a través de MongoDB Atlas. Utilice los siguientes métodos para acceder a la API:
API REST: para acceso independiente del idioma.
Cliente Python: cliente oficial para facilitar su uso.
Esta página resume cómo acceder a la API. Para obtener más información sobre la API, incluyendo los límites de velocidad y los niveles de uso, consulte Referencia API.
Claves de API
La API de Integración y Reclasificación utiliza claves API para supervisar el uso y administrar los permisos. Para crear y administrar las claves API de su modelo, utilice la interfaz de usuario de MongoDB Atlas. Para obtener instrucciones, consulte Claves API de modelo.
REST API
Los siguientes ejemplos demuestran cómo llamar al servicio de embedding a través de la API REST. La API admite cURL, así como solicitudes HTTP desde cualquier lenguaje de programación.
La autenticación se gestiona 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 de portador.
Para obtener más información, consulte la especificación API completa.
Cliente Python
Para instalar el paquete oficial de Python usando pip:
pip install --upgrade voyageai
Utilice la --upgrade -U opción o para instalar la última versión del paquete. Esto le dará acceso a las funciones y correcciones de errores más recientes. Para conocer los parámetros específicos del modelo, consulte los ejemplos de uso de cada página.
Importante
Debe usar la versión 0.3.7 o posterior de la biblioteca cliente de Python. Esta versión añade compatibilidad con la API de incrustación y reclasificación.
La clase voyageai.Client proporciona una interfaz síncrona para invocar la API de Voyage. Cree un objeto cliente y úselo para acceder a los modelos de IA de Voyage.
Ejemplo
El siguiente ejemplo muestra cómo inicializar el cliente con configuraciones personalizadas y generar incrustaciones:
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:
Parameter | Tipo | Requerido | Descripción |
|---|---|---|---|
| String | No | Clave API del modelo. El valor predeterminado es Ninguno. Si no hay ninguno, el cliente busca la clave API en el siguiente orden:
NOTA: El cliente Python enruta automáticamente las solicitudes al punto final de API correcto según el formato de la clave API:
Puede anular este comportamiento configurando el parámetro |
| entero | No | Número máximo de reintentos por cada solicitud de API en caso de errores de límite de velocidad o indisponibilidad temporal del servidor. El valor predeterminado es 0. El cliente emplea una estrategia de esperar y reintentar para gestionar estos errores y genera una excepción al alcanzar el límite máximo de reintentos. De forma predeterminada, el cliente no reintenta. |
| entero | No | Tiempo máximo en segundos que se espera una respuesta de la API antes de cancelar la solicitud. El valor predeterminado es Ninguno. Si se excede el tiempo de espera especificado, la solicitud se finaliza y se genera una excepción de tiempo de espera. De forma predeterminada, no se aplica ninguna restricción de tiempo de espera. |
| String | No | URL base personalizada para solicitudes de API. De forma predeterminada, el cliente detecta automáticamente el punto final correcto según la clave de API proporcionada. |