Você pode acessar os modelos de IA do Voyage usando a API de incorporação e reclassificação, disponível por meio do MongoDB Atlas. Use os seguintes métodos para acessar a API:
API REST: para acesso independente de idioma.
cliente Python: cliente oficial para facilidade de uso.
Esta página resume como acessar a API. Para obter detalhes completos sobre a API, incluindo limites de taxa e camadas de uso, consulte a Referência da API .
Chaves de API
A API de incorporação e reclassificação usa chaves de API para monitorar o uso e gerenciar permissões. Para criar e gerenciar suas chaves de API do modelo, use a UI do MongoDB Atlas . Para obter instruções, consulte Chaves de API do modelo.
REST API
Os exemplos a seguir demonstram como chamar o serviço de incorporação por meio da API REST. A API suporta cURL, bem como solicitações 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.
Cliente Python
Para instalar o pacote oficial do Python usando pip:
pip install --upgrade voyageai
Use a --upgrade -U opção ou 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.
Importante
Você deve usar a versão 0.3.7 ou posterior da biblioteca do cliente Python. Esta versão adiciona suporte para a API de incorporação e reclassificação.
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.
Exemplo
O exemplo a seguir mostra como inicializar o cliente com configurações personalizadas e gerar incorporações:
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:
Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| String | No | Chave API do modelo. O padrão é Nenhum. Se Nenhum, o cliente procurará a chave API na seguinte ordem:
NOTA: o cliente Python roteia automaticamente as solicitações para o ponto de extremidade da API correto com base no formato da chave da API:
Você pode substituir este comportamento configurando o parâmetro |
| Inteiro | No | Número máximo de tentativas para cada solicitação de API em caso de erros de limite de taxa ou indisponibilidade temporária do servidor . Padrão é 0. O cliente emprega uma estratégia de esperar e tentar novamente para lidar com esses erros e gerar uma exceção ao atingir o limite máximo de tentativas. Por padrão, o cliente não tenta novamente. |
| Inteiro | No | Tempo máximo, em segundos, para aguardar uma resposta da API antes de abortar a solicitação. O padrão é Nenhum. Se o tempo limite especificado for excedido, a solicitação será encerrada e uma exceção de tempo limite será gerada. Por padrão, nenhuma restrição de tempo limite é imposta. |
| String | No | URL base personalizada para solicitações de API. Por padrão, o cliente detecta automaticamente o endpoint correto com base na chave de API fornecida. |