BYOK
BYOK(Bring Your Own Key)は、自分で契約したプロバイダーのAPIキーをプロジェクトに登録して、そのAPIキーでモデルを呼び出す機能です。 費用はプロバイダーから直接請求されるので、ロリポップ!AIゲートウェイの手数料はかからず、クレジットも消費しません。
モデルによっては、BYOKでしか利用できません(GET /v1/models の byokRequired が true のモデル)。
プロバイダーのAPIキーを登録する
コンソールでプロジェクトを開き、プロバイダーで発行したAPIキーを登録します。
APIキーはプロバイダーごとに1つまでで、登録したあとは値を確認できません。
次のプロバイダーでは、入力する内容が異なります。
| プロバイダー | 入力する内容 |
|---|---|
| Google Cloud Vertex AI | サービスアカウントキーのJSON |
| Alibaba | APIキーと、接続先のURL |
登録したあとの動作
登録しても、アプリケーションを変更する必要はありません。 リクエストの認証にはこれまでどおりロリポップ!AIゲートウェイのAPIキーを使い、BYOKを登録したプロバイダーのモデルは、自動でそのAPIキーで呼び出されます。
BYOKで呼び出した分は、次のように扱われます。
| 項目 | 扱い |
|---|---|
| 予算とレート制限 | 対象に含まれます |
| 使用状況 | 「BYOK利用額の目安」として表示されます |
| プロバイダーがエラーを返したとき | 同じモデルを、ロリポップ!AIゲートウェイの料金で呼び出し直すことはありません |
プロバイダーのAPIキーを差し替える
登録したAPIキーは、新しいものに差し替えられます。 Alibabaでは、接続先のURLだけを更新することもできます。
プロバイダーのAPIキーを削除する
登録したAPIキーは削除できます。 削除しても、プロバイダーで発行したAPIキー自体は有効なままです。
削除したあとのリクエストは、次のように扱われます。
- BYOKなしでも使えるモデルは、通常どおりクレジットを消費して呼び出されます。
- プロバイダーのAPIキーの登録が必要なモデルを呼び出すと、
403(provider_credential_required)が返ります。
トラブルシューティング
| ステータスコード | code | 原因と対処 |
|---|---|---|
401 | invalid_api_key | 登録したプロバイダーのAPIキーがプロバイダーで無効になっているか、ロリポップ!AIゲートウェイのAPIキーが正しくありません。どちらの場合も同じエラーが返るため、両方のAPIキーを確認してください |
403 | provider_credential_required | プロバイダーのAPIキーの登録が必要なモデルを、登録なしで呼び出しています。プロバイダーのAPIキーを登録してください |