Docs Menu
Docs Home
/

モデルAPIキー

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

注意

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

4
  1. モデルAPIキーをコピーし、安全な場所に保存します。

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

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

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

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

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

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

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

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

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

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

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

4
  1. モデルAPIキーをコピーし、安全な場所に保存します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

次へ

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

項目一覧