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

モデルAPIキー

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

注意

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

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

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

必要な権限

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

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

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

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

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

API キーの作成

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

注意

次の手順で説明されているように、Atlas でモデルAPIキーを作成すると、そのキーは https://ai.mongodb.com/v1/embeddings へのリクエストのみを認証します。逆に、VyageAI を通じてキーを直接作成すると、https://api.voyageai.com/v1/embeddings へのリクエストが認証されます。

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

1

Atlas にログインします。

2

AI ModelsAtlas UIの ページにGo。

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

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

3

モデルAPIキーを作成します。

  1. [Create new model API key] をクリックします。

  2. キーの名前を入力します。

    モデルAPIキーは、250 文字を超えることはできません。

  3. ドロップダウンから、 APIキーにリンクするプロジェクトを選択します。

  4. [Create] をクリックします。

4

APIキーを保存します。

  1. モデルAPIキーをコピーし、安全なロケーションに保存します。

    キーが表示されているページを離れた後は、再度表示できなくなります。紛失した場合は、新しいものを作成してください。

  2. [Done] をクリックします。

プロジェクトレベルでモデルAPIキーを作成するには、次の手順を実行します。

1

Atlas にログインします。

2

AI ModelsAtlas UIの ページにGo。

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

  2. まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。

  3. プロジェクトレベルで、ナビゲーション バーの Services ヘッダーの下の AI Models をクリックします。

3

モデルAPIキーを作成します。

  1. まだ表示されていない場合は、ナビゲーション バーから [Model API Keys] を選択します。

  2. [Create model API key] をクリックします。

  3. キーの名前を入力します。

    モデルAPIキーは、250 文字を超えることはできません。

  4. [Create] をクリックします。

4

APIキーを保存します。

  1. モデルAPIキーをコピーし、安全なロケーションに保存します。

    キーが表示されているページを離れた後は、再度表示できなくなります。紛失した場合は、新しいものを作成してください。

  2. [Done] をクリックします。

APIキーの表示

組織の所有者は、組織のすべてのモデルAPIキーを組織レベルで表示および編集できます。プロジェクト所有者は、アクセス権を持つプロジェクトのモデルAPIキーのみを表示および編集できます。

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

1

Atlas にログインします。

2

AI ModelsAtlas UIの ページに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キーを表示するには、次の手順を実行します。

1

Atlas にログインします。

2

AI ModelsAtlas UIの ページにGo。

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

  2. まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。

  3. プロジェクトレベルで、ナビゲーション バーの Services ヘッダーの下の AI Models をクリックします。

モデル 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

Atlas にログインします。

2

AI ModelsAtlas UIの ページにGo。

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

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

3

キーを編集します。

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

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

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

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

プロジェクトレベルでモデルAPIキーを編集するには、次の手順を実行します。

1

Atlas にログインします。

2

AI ModelsAtlas UIの ページにGo。

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

  2. まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。

  3. プロジェクトレベルで、ナビゲーション バーの Services ヘッダーの下の AI Models をクリックします。

3

キーを編集します。

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

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

    名前はプロジェクト内で一意である必要があり、長さは最大 250 文字です。

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

API キーを削除する

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

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

1

Atlas にログインします。

2

AI ModelsAtlas UIの ページにGo。

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

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

3

キーを削除します。

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

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

プロジェクトレベルでモデルAPIキーを削除するには、次の手順を実行します。

1

Atlas にログインします。

2

AI ModelsAtlas UIの ページにGo。

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

  2. まだ表示されていない場合は、ナビゲーション バーのProjectsメニューから目的のプロジェクトを選択します。

  3. プロジェクトレベルで、ナビゲーション バーの Services ヘッダーの下の AI Models をクリックします。

3

キーを削除します。

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

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

次のステップ

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

次へ

組織とプロジェクトのアクセス

項目一覧