Voyage AI 모델에 액세스

API 키

Embedding and Reranking API는 사용량 모니터링 및 권한 관리를 위해 API 키를 사용합니다. 모델 API 키를 생성하고 관리하려면 MongoDB Atlas UI를 사용합니다. 지침은 Voyage AI 모델 API 키 관리를 참조하세요.

REST API

다음 예시는 REST API 통해 임베딩 서비스를 호출하는 방법을 보여줍니다. API는 모든 프로그래밍 언어에서 cURL 및 HTTP 요청을 지원합니다.

인증은 모델 API 키를 통해 처리되며, 이 키를 모든 API 요청의 권한 부여 헤더에 베어러 토큰으로 포함해야 합니다.

To learn more, see the full API specification.

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

Python 클라이언트

pip을(를) 사용하여 공식 Python 패키지 설치하려면 다음을 수행합니다.

pip install --upgrade voyageai

--upgrade 또는 -U 옵션을 사용하여 최신 버전의 패키지 설치합니다. 이를 통해 최신 기능 및 버그 수정에 액세스 할 수 있습니다. 모델별 매개변수는 각 모델 페이지의 사용 예시를 참조하세요.

voyageai.Client 클래스는 Voyage의 API 호출하기 위한 동기 인터페이스를 제공합니다. 클라이언트 객체 생성하고 이를 사용하여 Voyage AI 모델에 액세스 .

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}")

다음 표에서는 클라이언트 초기화할 때 전달할 수 있는 매개변수에 대해 설명합니다.

TypeScript 클라이언트

npm을(를) 사용하여 공식 Typescript 패키지 설치하려면 다음을 수행합니다.

npm install voyageai

VoyageAIClient 클래스는 TypeScript 및 JavaScript 애플리케이션에서 Voyage의 API 호출하기 위한 비동기 인터페이스를 제공합니다. 클라이언트 객체 생성하고 이를 사용하여 Voyage AI 모델에 액세스 .

Unlike the Python client, the TypeScript client sends requests to the Voyage platform endpoint (https://api.voyageai.com/v1) by default. To use the Embedding and Reranking API with your model API key, set the environment option to https://ai.mongodb.com/v1 when you create the client.

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}`);

다음 표에서는 클라이언트 초기화할 때 전달할 수 있는 옵션에 대해 설명합니다.

embed 외에도 클라이언트는 rerank, multimodalEmbed, 및 contextualizedEmbed 메서드를 제공합니다. 모델 특정 매개변수의 경우, 각 모델 페이지에서 사용 예시를 참조하세요.