임베딩 및 재순위 지정 API RESTful 인터페이스를 통해 최신 Voyage AI 임베딩 및 재순위 지정 모델에 프로그래밍 방식으로 액세스 제공합니다. 이 페이지에서는 API 와 해당 기능에 대한 개요를 제공합니다.
API 키 관리
MongoDB Atlas 사용하여 Embedding 및 Reranking API 에 대한 API 키를 관리 . 여기에는 조직 및 프로젝트 전반에서 모델 API 키 생성 및 관리, 사용량 모니터링 , 속도 제한 구성이 포함됩니다.
참고
Atlas 의 다른 API 키와 구별하기 위해 모델 API 키로 명명됩니다. 이 키는 다른 모델 제공자의 API 키와 동일한 방식으로 사용합니다.
인증
Embedding and Reranking API 에 대한 모든 요청에는 베어러 토큰 형식을 사용하는 모델 API 키와 함께 Authorization 헤더가 포함되어야 합니다.
Authorization: Bearer VOYAGE_API_KEY
클라이언트 SDK를 사용하는 경우 클라이언트 구성할 때 API 키를 설정하다 SDK가 모든 요청 에 대해 사용자를 대신하여 헤더를 전송합니다. API 와 직접 통합하는 경우 이 헤더를 직접 보내야 합니다.
JSON
모든 엔터티는 JSON 으로 표시됩니다. 다음 규칙과 규칙이 적용.
- 콘텐츠 유형 요청 헤더
- POST 요청 사용하여 서버 에 JSON 보낼 때
Content-Type: application/json헤더를 지정합니다. 클라이언트 SDK는 이를 자동으로 처리하다 . - 유효하지 않은 요청
- 잘못된 JSON, 잘못된 데이터 유형 또는 제약 조건 위반(예: 토큰 제한 또는 배치 크기 초과)을 사용하여 요청 생성하려고 하면 서버
400상태 코드와 문제를 설명하는 오류 메시지로 응답합니다. - 숫자가 포함된 필드의 필드 이름
- 숫자 값이 포함된 필드에는 사용 중인 단위를 명확하게 하기 위해 이름이 지정됩니다. 예시 를 들어 토큰 수는 측정 단위를 명확히 하기 위해
total_tokens및output_dimension같은 필드에 지정됩니다.
요금 한도 및 사용 계층
Embedding and Reranking API 공정한 사용과 최적의 성능을 보장하기 위해 속도 제한을 구현합니다. 속도 제한은 API 키별로 적용되며 2차원으로 측정됩니다.사용 계층을 올라갈수록 요금 한도가 증가합니다.
TPM(Tokens Per Minute): 분당 처리되는 최대 토큰 수
RPM (Requests Per Minute): 분당 최대 API 요청 수
속도 제한을 초과하면 API 429 (Rate Limit Exceeded) HTTP 상태 코드를 반환합니다.
결제 수단이 없는 무료 평가판 요금 한도는 3 RPM 및 10K TPM입니다. 더 높은 요금 한도를 적용하려면 계정에 결제 수단을 추가하세요.
모델 | Tokens Per Min (TPM) | 분당 요청(RPM) |
|---|---|---|
| 16,000,000 | 2,000 |
| 8,000,000 | 2,000 |
| 3,000,000 | 2,000 |
| 3,000,000 | 2,000 |
| 2,000,000 | 2,000 |
| 4,000,000 | 2,000 |
| 2,000,000 | 2,000 |
사용 계층 2 의 속도 제한은 사용 계층 1의 두 배입니다.
모델 | Tokens Per Min (TPM) | 분당 요청(RPM) |
|---|---|---|
| 32,000,000 | 4,000 |
| 16,000,000 | 4,000 |
| 6,000,000 | 4,000 |
| 6,000,000 | 4,000 |
| 4,000,000 | 4,000 |
| 8,000,000 | 4,000 |
| 4,000,000 | 4,000 |
사용 계층 3 의 요금 한도는 사용 계층 1의 3배입니다.
모델 | Tokens Per Min (TPM) | 분당 요청(RPM) |
|---|---|---|
| 48,000,000 | 6,000 |
| 24,000,000 | 6,000 |
| 9,000,000 | 6,000 |
| 9,000,000 | 6,000 |
| 6,000,000 | 6,000 |
| 12,000,000 | 6,000 |
| 6,000,000 | 6,000 |
사용 티어에 대해 자세히 학습 사용 티어를 참조하세요.
조직 에 대한 사용자 지정 속도 제한을 설정하다 하려면 Atlas UI 사용합니다. 자세한 학습 은 요금 제한 관리를 참조하세요.
요청하기
다음 예시 cURL 를 사용하여 임베딩 서비스에 요청 하는 방법을 보여 줍니다. 또한 모든 프로그래밍 언어 로 작성된 HTTP 클라이언트 사용하여 API 에 액세스 할 수 있습니다.
추가 사용 예시는 다음 리소스를 참조하세요.
HTTP 요청 및 클라이언트 SDK예제를 위한 Voyage AI 모델에 액세스
모델별 사용을 위한 모델 페이지입니다.
curl \ --request POST 'https://ai.mongodb.com/v1/embeddings' \ --header "Authorization: Bearer $VOYAGE_API_KEY" \ --header "Content-Type: application/json" \ --data '{ "input": [ "MongoDB is redefining what a database is in the AI era.", "Voyage AI embedding and reranking models are state-of-the-art." ], "model": "voyage-4-large" }'
오류
API 에서 반환되는 오류에 대해 자세히 학습 API 사양을 참조하세요.
모범 사례
API 사용할 때 다음 권장사항 고려하세요.
입력 유형 지정
시맨틱 검색 및 조회 작업의 경우 input_type 를 query 또는 document 로 설정하다 Voyage AI 모델이 벡터를 생성하는 방식을 최적화합니다. 이 매개변수를 생략하지 마세요.
이 매개변수는 임베딩을 생성하기 전에 입력에 다음 프롬프트를 추가합니다.
query: "지원 문서를 검색하기 위한 쿼리 를 나타냅니다: "document: "검색할 문서 를 나타냅니다: "
예시
input_type="query" 변환 "Apple의 전화 회의는 언제 예약되나요?" " Represents the 쿼리 for retreering concern:when Apple's 전화 회의가 예약되어 있나요?"로 변환합니다.
문제 해결
Python 클라이언트 사용하는 경우 0.3.7 버전 이상을 사용해야 합니다. Python 클라이언트 설치 버전을 확인하려면 터미널에서 다음 명령을 실행 .
python -c "import voyageai; print(voyageai.__version__)"