MongoDB Atlas 통해 제공되는 임베딩 및 리랭킹 API 사용하여 Voyage AI 모델에 액세스 할 수 있습니다. 다음 방법을 사용하여 API 에 액세스 .
이 페이지에는 API 액세스 방법이 요약되어 있습니다. 요금 제한 및 사용 계층을 포함하여 API 에 대한 자세한 내용은 API 참조를 참조하세요.
API 키
Embedding and Reranking API API 키를 사용하여 사용량을 모니터 하고 권한을 관리 . 모델 API 키를 생성하고 관리 하려면 MongoDB Atlas UI 사용합니다. 지침은 모델 API 키를 참조하세요.
REST API
다음 예시는 REST API 통해 임베딩 서비스를 호출하는 방법을 보여줍니다. API cURL과 모든 프로그래밍 언어 의 HTTP 요청을 지원합니다.
인증은 모델 API 키를 통해 처리되며, 이 키를 모든 API 요청의 권한 부여 헤더에 베어러 토큰으로 포함해야 합니다.
자세한 학습 은 전체 API 사양을 참조하세요.
Python 클라이언트
pip을 사용하여 공식 Python 패키지 설치하려면 다음을 수행합니다.
pip install --upgrade voyageai
--upgrade 또는 -U 옵션을 사용하여 최신 버전의 패키지 설치합니다. 이를 통해 최신 기능 및 버그 수정에 액세스 할 수 있습니다. 모델별 매개변수는 각 모델 페이지의 사용 예시를 참조하세요.
중요
Python 클라이언트 라이브러리의 버전 0.3.7 이상을 사용해야 합니다. 이 버전에는 Embedding 및 Reranking API 에 대한 지원 추가됩니다.
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}")
다음 표에서는 클라이언트 초기화할 때 전달할 수 있는 매개변수에 대해 설명합니다.
Parameter | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
| 문자열 | No | 모델 API 키입니다. 기본값은 없음입니다. 없음인 경우 클라이언트 다음 순서로 API 키를 검색합니다.
참고: Python 클라이언트 는 API 키 형식에 따라 요청을 올바른 API 엔드포인트로 자동 라우팅합니다.
클라이언트 만들 때 |
| Integer | No | 속도 제한 오류 또는 일시적으로 서버 사용할 수 없는 경우 각 API 요청 에 대한 최대 재시도 횟수입니다. 기본값은 0입니다. 클라이언트 대기 후 재시도 전략을 사용하여 이러한 오류를 처리하다 하고 최대 재시도 제한에 도달하면 예외를 발생시킵니다. 기본값 으로 클라이언트 재시도하지 않습니다. |
| Integer | No | 요청 중단하기 전에 API 의 응답을 기다리는 최대 시간(초)입니다. 기본값은 없음입니다. 지정된 시간 초과를 초과하면 요청 종료되고 시간 초과 예외가 발생합니다. 기본값 으로 시간 초과 제약 조건이 적용되지 않습니다. |
| 문자열 | No | API 요청에 대한 사용자 지정 기본 URL . 기본값 으로 클라이언트 제공된 API 키를 기반으로 올바른 엔드포인트를 자동으로 감지합니다. |