モデル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 エンドポイントへのリクエストを認証します。逆に、VyageAI を通じてキーを直接作成すると、キーは https://api.voyageai.com/v1/embeddings へのリクエストを認証します。
キーを作成するときに、そのキーのスコープも設定します。詳細については、「 キー範囲 」を参照してください。
組織レベルでモデルAPIキーを作成するには、次の手順を実行します。
Log in to Atlas.
モデルAPIキーを作成します。
[Create new model API key] をクリックします。
キーの名前を入力します。
モデルAPIキーは、250 文字を超えることはできません。
ドロップダウンから、 APIキーにリンクするプロジェクトを選択します。
Cloud provider ドロップダウンからクラウドプロバイダーを選択します。
クラウドディメンションのスコープを設定しないままにするには、
anyを選択します。任意。 Geography ドロップダウンから地域を選択します。
ほとんどのキーには地理的は必要ありません。地理ディメンションのスコープを解除するには、
anyを選択します。Atlas には、選択したスコープの読み取り専用 API Endpoint が表示されます。キーはこのエンドポイントに対して認証します。
[Create] をクリックします。
プロジェクトレベルでモデルAPIキーを作成するには、次の手順を実行します。
Log in to Atlas.
モデルAPIキーを作成します。
まだ表示されていない場合は、ナビゲーション バーから [Model API Keys] を選択します。
[Create model API key] をクリックします。
キーの名前を入力します。
モデルAPIキーは、250 文字を超えることはできません。
Cloud provider ドロップダウンからクラウドプロバイダーを選択します。
クラウドディメンションのスコープを設定しないままにするには、
anyを選択します。任意。 Geography ドロップダウンから地域を選択します。
ほとんどのキーには地理的は必要ありません。地理ディメンションのスコープを解除するには、
anyを選択します。Atlas には、選択したスコープの読み取り専用 API Endpoint が表示されます。キーはこのエンドポイントに対して認証します。
[Create] をクリックします。
キーの範囲
注意
パブリック プレビュー
ヨーロッパ地理とそのエンドポイントである eu.ai.mongodb.com は、パブリック プレビュー機能として利用できます。機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。
モデルAPIキーを作成するときは、cloud と geography を指定します。これらは一緒にキーのスコープを設定し、キーが認証するエンドポイントを決定します。
そのディメンションのスコープを設定しないままにするには、いずれかの値を any に設定します。 cloud と geography の両方が any に設定されているキーは、スコープが設定されていないキーで、ai.mongodb.com に対して機能します。
エンドポイント | 地理 |
|---|---|
| スコープが設定されていない。 Atlas はどの地域からのリクエストも処理できます。 |
| ヨーロッパ |
| 米国 |
スコープ付きエンドポイントはパターン <geography>.ai.mongodb.com に従います。ここでは、<geography> はリクエストで送信したモデルAPIキーの geography 値です。
地理とはどのようなものであり、キーのスコープを 1 に設定するタイミングについては、「 投票AI推論の地理的配置 」を参照してください。
キーをスコープ設定するときは、次の点を考慮してください。
スコープは、キーを作成するときに固定されます。別のクラウドまたは地理を使用するには、キーを削除して新しいキーを作成します。モデルAPIキーに対する
PATCHリクエストでは、キーの名前のみが変更されます。キー プレフィックスはスコープをエンコードします。例、ヨーロッパにスコープを設定したキーは
al-eu-で始まります。プレフィックスを使用して、キーを再作成せずにスコープを識別します。スコープ付きキーには有料の使用階層が必要です。無料試用版でキーのスコープを設定することはできません。詳細については、「 使用階層 」を参照してください。
地理的条件が利用可能になる前に作成したモデルAPIキーは、cloud=any と geography=any として読み取り可能です。これらのキーは ai.mongodb.com に対して引き続き機能し、移行されません。スコープを使用するには、新しいキーを作成します。
リソース ポリシーを使用してモデルAPIキーのスコープを制限する
組織レベルでリソースポリシーを設定して、特定のクラウド、特定の 地理 、またはその両方で新しいモデルAPIキーを作成することを要求できます。これを行うには、埋め込みと再ランク付けAPIアクションを対象とする Cedar で記述された forbid ルールを追加します。
ポリシーは、キーの作成を制御します。既存のキーが使用される場所を制限しません。このポリシーを構成すると、ユーザーは許可された範囲外のキーを作成できなくなります。ただし、このポリシーではすでに存在するキーを取り消したり、再スコープ設定したりすることはありません。これらのキーは引き続き機能します。ポリシーに先行するキーを削除するには、 「 APIキーの削除 」を参照してください。
特定のスコープを許可するには、forbid ルールで unless 句を使用します。
forbid (principal, action == ResourcePolicy::Action::"project.aiModelAPI.modify", resource) unless { <exception> };
キーを地理的記録に制限するには、unless 句で context.aiModelApi.geography 属性を使用します。次のポリシーにより、ユーザーはヨーロッパ地域のみのモデルAPIキーを作成できます。
forbid (principal, action == ResourcePolicy::Action::"project.aiModelAPI.modify", resource) unless { context.aiModelApi.geography == ResourcePolicy::Geography::"eu" };
リソースポリシーの設定の詳細については、「 Atlas リソース ポリシーの概要 」を参照してください。
APIキーの表示
組織の所有者は、組織のすべてのモデルAPIキーを組織レベルで表示および編集できます。プロジェクト所有者は、アクセス権を持つプロジェクトのモデルAPIキーのみを表示および編集できます。
組織レベルでモデルAPIキーを表示するには、次の手順を実行します。
Log in to Atlas.
各モデルAPIキーについて、ページには以下が表示されます：
列名 | 列の値の説明 |
|---|---|
Name | モデル API キーの名前。 |
Secret Key | モデル API キー名に関連するモデル API キーを隠しました。 |
Created On (UTC) | ユーザーがモデル API キーを作成した時の UTC での日付。 |
Last Used (UTC) | モデル API キーが最後に使用された日付（UTC）。キーが新規であるか、または使用されたことがない場合、値は |
Project | モデル API キーにリンクされているプロジェクトの名前。 |
Created By | キーを作成したユーザーの名前。 |
Actions | キーで実行できるアクション。次のコマンドをクリックできます。
|
プロジェクトレベルでモデルAPIキーを表示するには、次の手順を実行します。
Log in to Atlas.
モデル API キーごとに、ページにキーに関する次の情報が表示されます。
列名 | 列の値の説明 |
|---|---|
Name | モデル API キーの名前。 |
Secret Key | モデル API キー名に関連するモデル API キーを隠しました。 |
Created On (UTC) | ユーザーがモデル API キーを作成した時の UTC での日付。 |
Last Used (UTC) | モデル API キーが最後に使用された日付（UTC）。キーが新規であるか、または使用されたことがない場合、値は |
Project | モデル API キーにリンクされているプロジェクトの名前。 |
Created By | キーを作成したユーザーの名前。 |
Actions | キーで実行できるアクション。次のコマンドをクリックできます。
|
APIキーの編集
API キーを削除する
モデルAPIキーを削除すると、 MongoDB はすぐにキーを無効にし、削除されたキーを使用して行われたAPIリクエストを拒否します。キーを削除すると、表示、復元、または変更することはできません。
次のステップ
モデルAPIキーを作成すると、次のことができます。
APIキーの使用状況をリアルタイムでモニターします。