AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu
Voyage AI モデル ホーム
Voyage AI モデル ホーム
Voyage AI モデル ホーム

Voyage AI モデル API キーの管理

モデルAPIキーは、埋め込み API および再ランクAPIの認証および承認メカニズムとして機能し、 APIからVoyage AIモデルにアクセスできるようにします。このページでは、 Atlas UIでAPIキーを作成および管理する方法について説明します。

注意

Atlas の他のAPIキーと区別するために、モデルAPIキー という名前が付けられています。このキーは、他のモデルプロバイダーのAPIキーと同じ方法で使用します。

モデルAPIキーの作成と管理

Atlas UIから組織とプロジェクトレベルでモデルAPIキーを作成および管理できます。 API キーに組織またはプロジェクトレベルのどちらで作成されたかに応じて、 APIキーにレート制限が適用されます。

必要な権限

モデルAPIキーを作成、更新、削除するには、次の手順に従います。

モデルAPIキーを表示するには:

  • Organization Read Only組織レベルとプロジェクトレベルで、Atlas への 以上のアクセス権が必要です。

  • Project Read Onlyプロジェクトレベルのみで、Atlas への 以上のアクセス権が必要です。

各ロールの権限の完全なリストについては、「組織とプロジェクトのアクセス」を参照してください。

API キーの作成

組織レベルでモデルAPIキーを作成したら、そのキーをプロジェクトにリンクします。キーを作成した後は、キーがリンクされているプロジェクトを変更することはできません。レート制限は、プロジェクト内の各キーに適用されます。

注意

Atlas を通じてモデル API キーを作成した場合、以下の手順で説明されているように、そのキーは ai.mongodb.com エンドポイントとなる接続されたデバイスへのリクエストを認証します。一方、Voyage AI を通じて直接キーを作成した場合、そのキーは https://api.voyageai.com/v1/embeddings へのリクエストを認証します。

キーを作成するときに、そのキーのスコープも設定します。詳細については、「 キー範囲 」を参照してください。

組織レベルでモデルAPIキーを作成するには、次の手順を実行します。

1
Log in to Atlas.
2
Go to the AI Model APIs page in the Atlas UI.

  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 ドロップダウンから地域を選択します。

    ほとんどのキーは 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> はリクエストとともに送信する model API キーの geography の値です。

Geography とは何か、およびキーをいつ Geography に関連付けるかを学ぶには、Voyage AI Inference のための Geography を参照してください。

キーの範囲を指定する際は、次の点を考慮してください。

  • キーを作成するとき、スコープは固定されます。別のクラウドまたはリージョンを使用するには、キーを削除して新しいキーを作成します。モデル API キーへの PATCH リクエストでは、キーの名前のみが変更されます。

  • キープレフィックスはスコープをエンコードします。例として、ヨーロッパにスコープされたキーは al-eu- で始まります。プレフィックスを使用して、キーのスコープを再作成せずに識別します。

  • スコープキーには有料の使用階層が必要です。無料トライアルではキーのスコープを設定できません。学ぶには 「利用階層」をご覧ください。

Geographies が利用可能になる前に作成したモデル API キーは、cloud=any と geography=any として読み取られます。これらのキーは ai.mongodb.com でも引き続き機能しますが、移行されません。スコープを使用するには、新しいキーを作成します。

リソース ポリシーを使用したモデル API キーの範囲制限

組織レベルでリソース ポリシーを設定して、新しいモデル API キーが特定のクラウド、特定の地域、またはその両方で作成されるように要求することができます。これを行うには、Embedding and Reranking API アクションをターゲットとする Cedar で記述された 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キーを表示するには、次の手順を実行します。

1
Log in to Atlas.
2
Go to the AI Model APIs page in the Atlas UI.

  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
Go to the AI Model APIs page in the Atlas UI.

  1. まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー

  2. 組織レベルで、ナビゲーション バーの Services ヘッダーの下の Model API Keys をクリックします。

3

キーを編集します。

  1. Actions 列で、編集するキーに対応する をクリックします。

  2. Edit Model API Key ページで、モデルAPIキーの名前を変更します。

    モデルAPIキー名はプロジェクトに対して一意である必要があり、長さは最大 250 文字です。

  3. 変更を適用するには、 Saveをクリックします。

API キーを削除する

モデルAPIキーを削除すると、 MongoDB はすぐにキーを無効にし、削除されたキーを使用して行われたAPIリクエストを拒否します。キーを削除すると、表示、復元、または変更することはできません。

組織レベルでモデルAPIキーを削除するには、次の手順を実行します。

1
Log in to Atlas.
2
Go to the AI Model APIs page in the Atlas UI.

  1. まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー

  2. 組織レベルで、ナビゲーション バーの Services ヘッダーの下の Model API Keys をクリックします。

3

キーを削除します。

  1. Actions 列で、削除するキーに対応する をクリックします。

  2. 確認モーダルで、Delete key をクリックしてキーを削除します。

次のステップ

モデルAPIキーを作成すると、次のことができます。

次へ
組織とプロジェクトのアクセス
このページを評価

項目一覧