Voyage AI 모델 API 키 관리

모델 API 키는 임베딩 및 리랭킹 API 에 대한 인증 및 권한 부여 메커니즘 제공 을 하며, 이를 통해 API 통해 Voyage AI 모델에 액세스 할 활성화 . 이 페이지에서는 Atlas UI 에서 API 키를 생성하고 관리 방법을 설명합니다.

참고

Atlas 의 다른 API 키와 구별하기 위해 모델 API 키 로 명명됩니다. 이 키는 다른 모델 제공자의 API 키와 동일한 방식으로 사용합니다.

모델 API 키 생성 및 관리

조직 및 프로젝트 수준의 Atlas UI 에서 모델 API 키를 만들고 관리 할 수 있습니다. 비율 제한 은 조직 또는 프로젝트 수준에서 생성했는지 여부에 따라 API 키에 적용.

필수 권한

모델 API 키를 생성, 업데이트 및 삭제 하려면 다음을 수행합니다.

조직 수준에서 Atlas 에 대한 액세스 있어야 Organization Owner 합니다.
프로젝트 수준에서 Atlas 에 Project Model Owner 대한, 이상의 액세스 있어야 합니다. Project Owner

모델 API 키를 보려면 다음을 수행합니다.

조직 및 프로젝트 수준에서 Atlas 에 대한 이상의 액세스 있어야 Organization Read Only 합니다.
프로젝트 수준에서만 Atlas 에 대한 이상의 액세스 있어야 Project Read Only 합니다.

각 역할에 대한 전체 권한 목록은 조직 및 프로젝트 액세스를 참조하세요.

API 키 생성

조직 수준에서 모델 API 키를 생성 하는 경우 키를 프로젝트에 연결합니다. 키를 생성한 후에는 키가 연결된 프로젝트 변경할 수 없습니다. 비율 제한은 프로젝트 의 각 키에 적용 .

참고

다음 절차에 설명된 대로 Atlas 통해 모델 API 키를 생성하는 경우, 키는 ai.mongodb.com 엔드포인트에 대한 요청을 인증합니다. 반대로VoyageAI를 통해 직접 키를 생성하는 경우 키는 https://api.voyageai.com/v1/embeddings에 대한 요청을 인증합니다.

키를 생성할 때 키의 범위도 설정하다 . 자세한 학습 은 키 범위를 참조하세요.

조직 수준에서 모델 API 키를 생성하려면 다음 단계를 완료하세요.

Atlas 에 로그인합니다.

Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
조직 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 Model API Keys 을 클릭합니다.

모델 API 키를 생성합니다.

Create new model API key를 클릭합니다.
키의 이름을 입력합니다.
모델 API 키는 250 자를 초과할 수 없습니다.
드롭다운에서 프로젝트 선택하여 API 키와 연결합니다.
Cloud provider 드롭다운에서 cloud 제공자 선택합니다.
cloud 차원의 범위를 지정하지 않은 상태로 두려면 any을 선택합니다.
선택 사항. Geography 드롭다운에서 지역을 선택합니다.
대부분의 키에는 지리가 필요하지 않습니다. 지리 차원의 범위를 지정하지 않은 상태로 두려면 any을(를) 선택합니다.
선택한 범위에 대해 읽기 전용 API Endpoint이(가 ) Atlas 에 표시됩니다. 키는 이 엔드포인트에 대해 인증합니다.
Create를 클릭합니다.

API 키를 저장합니다.

모델 API 키를 복사하여 안전한 위치 에 저장 .
키가 표시된 페이지를 벗어나면 다시 볼 수 없습니다. 분실한 경우 새로 생성합니다.
Done를 클릭합니다.

프로젝트 수준에서 모델 API 키를 만들려면 다음 단계를 완료하세요.

Atlas 에 로그인합니다.

Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
프로젝트 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 AI Model APIs 을 클릭합니다.

모델 API 키를 생성합니다.

아직 표시되지 않은 경우 탐색 모음에서 Model API Keys 을(를) 선택합니다.
Create model API key를 클릭합니다.
키의 이름을 입력합니다.
모델 API 키는 250 자를 초과할 수 없습니다.
Cloud provider 드롭다운에서 cloud 제공자 선택합니다.
cloud 차원의 범위를 지정하지 않은 상태로 두려면 any을 선택합니다.
선택 사항. Geography 드롭다운에서 지역을 선택합니다.
대부분의 키에는 지리가 필요하지 않습니다. 지리 차원의 범위를 지정하지 않은 상태로 두려면 any을(를) 선택합니다.
선택한 범위에 대해 읽기 전용 API Endpoint이(가 ) Atlas 에 표시됩니다. 키는 이 엔드포인트에 대해 인증합니다.
Create를 클릭합니다.

API 키를 저장합니다.

모델 API 키를 복사하여 안전한 위치 에 저장 .
키가 표시된 페이지를 벗어나면 다시 볼 수 없습니다. 분실한 경우 새로 생성합니다.
Done를 클릭합니다.

주요 범위

참고

공개 미리보기

유럽 지리 및 해당 엔드포인트인 eu.ai.mongodb.com는 공개 미리 보기 기능 으로 사용할 수 있습니다. 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다.

모델 API 키를 만들 때 cloud 및 geography를 제공합니다. 이들은 함께 키의 범위를 설정하다 , 이는 키가 인증하는 엔드포인트를 결정합니다.

해당 차원을 범위 지정하지 않은 상태로 두려면 두 값 중 하나를 any로 설정합니다. cloud 및 geography가 모두 any로 설정하다 키는 범위가 지정되지 않은 키이며 ai.mongodb.com에 대해 작동합니다.

엔드포인트	지리
`ai.mongodb.com`	범위 없음. Atlas 모든 지리적 위치에서 요청 제공 할 수 있습니다.
`eu.ai.mongodb.com`	유럽
`us.ai.mongodb.com`	미국

범위가 지정된 엔드포인트는 <geography>.ai.mongodb.com 패턴 따르며, 여기서 <geography> 은 요청 과 함께 전송하는 모델 API 키의 geography 값입니다.

지리란 무엇이며 키 범위를 지정해야 하는 경우에 대해 학습 지리 forVoyage AI 추론을 참조하세요.

키 범위를 지정할 때 다음 사항을 고려하세요.

범위는 키를 생성할 때 고정됩니다. 다른 cloud 또는 지리를 사용하려면 키를 삭제 하고 새 클라우드를 생성하세요. 모델 API 키에 대한 PATCH 요청 키 이름만 변경합니다.
키 접두사는 범위를 인코딩합니다. 예시 를 들어 유럽으로 범위가 지정된 키는 al-eu-로 시작합니다. 키를 다시 생성하지 않고 키의 범위를 식별하려면 접두사를 사용합니다.
범위가 지정된 키에는 유료 사용 계층 필요합니다. 무료 평가판에서는 키 범위를 지정할 수 없습니다. 자세한 학습 은 사용 계층을 참조하세요.

지리를 사용할 수 있기 전에 생성한 모델 API 키는 cloud=any 및 geography=any(으)로 읽힙니다. 이러한 키는 ai.mongodb.com에 대해 계속 작동하며 마이그레이션되지 않습니다. 범위를 사용하려면 새 키를 만듭니다.

리소스 정책을 사용하여 모델 API 키 범위 제한

조직 수준에서 리소스 정책을 구성하여 특정 cloud , 특정 지역 또는 둘 다에서 새 모델 API 키를 생성하도록 요구할 수 있습니다. 이렇게 하려면 임베딩 및 API 재순위 지정 조치 대상으로 하는 시더로 작성된 forbid 규칙을 추가합니다.

정책은 키 생성을 관리합니다. 기존 키가 사용되는 위치를 제한하지 않습니다. 이 정책을 구성하면 사용자는 허용된 범위를 벗어나서 키를 만들 수 없습니다. 그러나 이 정책은 이미 존재하는 키를 해지하거나 범위를 다시 지정하지 않습니다. 해당 키는 계속 작동합니다. 정책보다 오래된 키를 제거 하려면 API 키 삭제를 참조하세요.

forbid 규칙의 unless 절을 사용하여 특정 범위를 허용할 수 있습니다.

예시: 예외가 있는 모델 API 키 범위 제한

forbid (principal, action == ResourcePolicy::Action::"project.aiModelAPI.modify", resource) unless { <exception> };

키를 지리로 제한하려면 unless 절에서 context.aiModelApi.geography 속성을 사용합니다. 다음 정책은 사용자가 유럽 지역에 대해서만 모델 API 키를 생성하도록 허용합니다.

예시: 모델 API 키를 유럽 지역으로 제한

forbid (principal, action == ResourcePolicy::Action::"project.aiModelAPI.modify", resource) unless { context.aiModelApi.geography == ResourcePolicy::Geography::"eu" };

리소스 정책 설정에 대해 자세히 학습 Atlas 리소스 정책 개요를 참조하세요.

API 키 보기

조직 소유자는 조직 수준에서 조직의 모든 모델 API 키를 보고 편집 할 수 있습니다. 프로젝트 소유자는 액세스 있는 프로젝트의 모델 API 키만 보고 편집할 수 있습니다.

조직 수준에서 모델 API 키를 보려면 다음 단계를 완료하세요.

Atlas 에 로그인합니다.

Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
조직 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 Model API Keys 을 클릭합니다.

각 모델 API 키에 대해 페이지에 다음이 표시됩니다.

열 이름	열 값 설명
Name	모델 API 키 이름입니다.
Secret Key	모델 API 키 이름과 연결된 수정된 모델 API 키.
Created On (UTC)	사용자가 모델 API 키를 만든 시점의 UTC 날짜.
Last Used (UTC)	모델 API 키가 마지막으로 사용된 UTC 시간의 날짜입니다. 키가 새로운 거나 사용된 적이 없는 경우 값은 `Never` 입니다.
Project	모델 API 키와 연결된 프로젝트 이름입니다.
Created By	키를 만든 사용자의 이름
Actions	키에 대해 수행할 수 있는 조치입니다. 다음을 클릭할 수 있습니다. 모델 API 키를 편집합니다. 모델 API 키를 삭제합니다.

프로젝트 수준에서 모델 API 키를 보려면 다음 단계를 완료하세요.

Atlas 에 로그인합니다.

Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
프로젝트 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 AI Model APIs 을 클릭합니다.

각 모델 API 키에 대해 페이지에는 해당 키에 대한 다음 정보가 표시됩니다:

열 이름	열 값 설명
Name	모델 API 키 이름입니다.
Secret Key	모델 API 키 이름과 연결된 수정된 모델 API 키.
Created On (UTC)	사용자가 모델 API 키를 만든 시점의 UTC 날짜.
Last Used (UTC)	모델 API 키가 마지막으로 사용된 UTC 시간의 날짜입니다. 키가 새로운 거나 사용된 적이 없는 경우 값은 `Never` 입니다.
Project	모델 API 키와 연결된 프로젝트 이름입니다.
Created By	키를 만든 사용자의 이름
Actions	키에 대해 수행할 수 있는 조치입니다. 다음을 클릭할 수 있습니다. 모델 API 키를 편집합니다. 모델 API 키를 삭제합니다.

API 키 편집

조직 수준에서 모델 API 키를 편집하려면 다음 단계를 완료하세요.

Atlas 에 로그인합니다.

Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
조직 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 Model API Keys 을 클릭합니다.

키를 편집합니다.

Actions 열에서 편집하려는 키에 해당하는 를 클릭합니다.
Edit Model API Key 페이지에서 모델 API 키의 이름을 수정합니다.
모델 API 키 이름은 프로젝트 에서 고유해야 하며 최대 250 자까지 가능합니다.
Save를 클릭하여 변경 사항을 적용하세요.

프로젝트 수준에서 모델 API 키를 편집하려면 다음 단계를 완료하세요.

Atlas 에 로그인합니다.

Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
프로젝트 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 AI Model APIs 을 클릭합니다.

키를 편집합니다.

Actions 열에서 편집하려는 키에 해당하는 를 클릭합니다.
Edit Model API Key 페이지에서 모델 API 키의 이름을 수정합니다.
이름은 프로젝트 에서 고유해야 하며 최대 250 자까지 가능합니다.
Save를 클릭하여 변경 사항을 적용하세요.

API 키 삭제

When you 모델 API 키를 삭제 하면 MongoDB 즉시 키를 비활성화하고 삭제된 키를 사용하여 이루어진 모든 API 요청을 거부합니다. 키를 삭제 하면 보거나 복원 하거나 수정할 수 없습니다.

조직 수준에서 모델 API 키를 삭제 하려면 다음 단계를 완료하세요.

Atlas 에 로그인합니다.

Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
조직 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 Model API Keys 을 클릭합니다.

키를 삭제합니다.

Actions 열에서 삭제 하려는 키에 해당하는 을(를) 클릭합니다.
확인 모달에서 Delete key 을 클릭하여 키를 삭제 .

프로젝트 수준에서 모델 API 키를 삭제 하려면 다음 단계를 완료하세요.

Atlas 에 로그인합니다.

Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
아직 표시되지 않은 경우 탐색 표시줄의 Projects 메뉴에서 원하는 프로젝트를 선택합니다.
프로젝트 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 AI Model APIs 을 클릭합니다.

키를 삭제합니다.

Actions 열에서 삭제 하려는 키에 해당하는 을(를) 클릭합니다.
확인 모달에서 Delete key 을 클릭하여 키를 삭제 .

다음 단계

모델 API 키를 만든 후에는 다음을 수행할 수 있습니다.

조직 및 프로젝트 액세스