AI 에이전트의 경우: 문서 인덱스는 https://www.mongodb.com/ko-kr/docs/llms.txt에서 사용할 수 있으며, 모든 페이지의 마크다운 버전은 어떤 URL 경로에 .md를 추가하여 사용할 수 있습니다.
Docs Menu
Voyage AI 모델 홈
Voyage AI 모델 홈
Voyage AI 모델 홈

Voyage AI 모델 API 키 관리

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

참고

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

모델 API 키 생성 및 관리

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

필수 권한

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

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

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

API 키 생성

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

참고

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

You also set the key's scope when you create it. To learn more, see Key Scope.

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

1
Log in to Atlas.
2
Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

  1. 아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.

  2. 조직 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 Model API Keys 을 클릭합니다.

3

모델 API 키를 생성합니다.

  1. Create new model API key를 클릭합니다.

  2. 키의 이름을 입력합니다.

    모델 API 키는 250 자를 초과할 수 없습니다.

  3. 드롭다운에서 프로젝트 선택하여 API 키와 연결합니다.

  4. Cloud provider 드롭다운에서 클라우드 공급자를 선택합니다.

    클라우드 차원을 범위 지정 없이 남겨두려면 any을 선택하세요.

  5. 선택 사항입니다. Geography 드롭다운에서 지역을 선택합니다.

    대부분의 키는 지리 정보가 필요하지 않습니다. any을(를) 선택하여 지리 차원을 범위 지정되지 않은 상태로 두십니다.

    Atlas가 선택한 범위에 대한 읽기 전용 API Endpoint을 표시합니다. 키는 이 엔드포인트에 대해 인증합니다.

  6. Create를 클릭합니다.

4

API 키를 저장합니다.

  1. 모델 API 키를 복사하여 안전한 위치 에 저장 .

    키가 표시된 페이지를 벗어나면 다시 볼 수 없습니다. 분실한 경우 새로 생성합니다.

  2. Done를 클릭합니다.

주요 범위

모델 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 값입니다.

Geography가 무엇인지 학습하고 키를 어떤 Geography에 적용해야 하는지 학습하려면, Voyage AI 추론을 위한 Geography를 참조하세요.

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

  • 키를 생성할 때 스코프가 고정됩니다. 다른 클라우드 또는 지역을 사용하려면 키를 삭제하고 새 키를 만드세요. PATCH 요청은 모델 API 키의 이름만 변경합니다.

  • 키 접두사는 범위를 인코딩합니다. 예시, 유럽 범위의 키는 al-eu-으로 시작합니다. 접두사를 사용하여 키의 범위를 다시 만들지 않고 식별합니다.

  • 스코프 키에는 유료 사용 계층이 필요합니다. 무료 평가판에서는 키의 범위를 지정할 수 없습니다. 자세한 내용은 사용 계층을 참조하세요.

Geographies가 사용 가능하기 전에 만든 모델 API 키는 cloud=any 및 geography=any로 읽힙니다. 이 키들은 ai.mongodb.com에 대하여 계속 작동하며 마이그레이션되지 않습니다. 스코프를 사용하려면 새 키를 만듭합니다.

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

조직 수준에서 리소스 정책을 구성하여 새 모델 API 키가 특정 클라우드, 특정 지역 또는 두 개 모두에서 생성되도록 요구할 수 있습니다. 이를 위해, Embedding and Reranking API 조치를 대상으로 하는 Cedar로 작성된 forbid 규칙을 추가합니다.

The policy governs key creation. It does not constrain where an existing key is used. If you configure this policy, users can't create keys outside the scope you allow. However, the policy doesn't revoke or re-scope keys that already exist. Those keys keep working. To remove a key that predates the policy, see Delete an API Key.

forbid 규칙에서 unless 조항을 사용하여 특정 범위를 허용할 수 있습니다.

예시: 예외를 포함한 모델 API 키 범위 제한
forbid (principal, action == ResourcePolicy::Action::"project.aiModelAPI.modify", resource) unless { <exception> };

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

예시: 유럽 지역으로 모델 API 키 제한
forbid (principal, action == ResourcePolicy::Action::"project.aiModelAPI.modify", resource) unless { context.aiModelApi.geography == ResourcePolicy::Geography::"eu" };

To learn more about setting the resource policy, see Atlas Resource Policies Overview.

API 키 보기

Organization owners can view and edit all model API keys for the organization at the organization level. Project owners can view and edit only the model API keys for the projects to which they have access.

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

1
Log in to Atlas.
2
Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

  1. 아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.

  2. 조직 수준에서 탐색 표시줄의 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 키 편집

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

1
Log in to Atlas.
2
Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

  1. 아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.

  2. 조직 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 Model API Keys 을 클릭합니다.

3

키를 편집합니다.

  1. Actions 열에서 편집하려는 키에 해당하는 를 클릭합니다.

  2. Edit Model API Key 페이지에서 모델 API 키의 이름을 수정합니다.

    모델 API 키 이름은 프로젝트 에서 고유해야 하며 최대 250 자까지 가능합니다.

  3. Save를 클릭하여 변경 사항을 적용하세요.

API 키 삭제

When you delete a model API key, MongoDB immediately disables the key and rejects any API requests made using the deleted key. Once you delete the key, you can't view, restore, or modify it.

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

1
Log in to Atlas.
2
Atlas UI 에서 AI Model APIs 페이지로 고 (Go) .

  1. 아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.

  2. 조직 수준에서 탐색 표시줄의 Services 헤더 아래에 있는 Model API Keys 을 클릭합니다.

3

키를 삭제합니다.

  1. Actions 열에서 삭제 하려는 키에 해당하는 을(를) 클릭합니다.

  2. 확인 모달에서 Delete key 을 클릭하여 키를 삭제 .

다음 단계

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

다음
조직 및 프로젝트 액세스
이 페이지 평가하기

이 페이지의 내용