BYOK
BYOK:自分で契約したプロバイダーのAPIキーをプロジェクトへ登録して使う機能です。 登録が完了すると、そのプロジェクトでは追加の切り替え操作なしで登録したAPIキーを利用します。
登録する
ダッシュボードから対象プロジェクトを開き、サイドバーの「BYOK」を選びます。 画面には、そのプロジェクトで登録できるプロバイダーが並びます。 プロバイダーを選び、そのプロバイダーで発行したAPIキーを入力して登録します。
登録したキーの平文は画面に表示されません。 一覧には「登録済み」と、次のいずれかの状態が表示されます。
| 状態 | 意味 |
|---|---|
| 利用中 | このプロジェクトの推論で、このキーを使っている |
| 未使用 | 登録されているが、このプロジェクトの推論では使われていない |
| 停止中 | 停止したキー。推論には使われない |
差し替える、停止する
各キーの操作メニューから「差し替える」と「停止する」を選べます。 差し替えでは新しいAPIキーを入力して上書きします。 停止したキーは推論に使われません。 停止したあとに同じプロバイダーへ登録し直すと、利用を再開できます。
停止したキーがプラットフォーム認証情報へ自動的に切り替わることはありません。
推論する
登録後も、推論リクエストの形式は変わりません。 プロバイダーのAPIキーではなく、プロジェクトで発行したロリポップ!AIゲートウェイのAPIキーを認証に使います。
curl "$AI_GATEWAY_BASE_URL/v1/chat/completions" \
-H "Authorization: Bearer $AI_GATEWAY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "<GET /v1/modelsが返したモデルID>",
"messages": [
{ "role": "user", "content": "こんにちは。" }
]
}'プロバイダーのAPIキーやプロバイダー名をリクエストボディへ含める必要はありません。
表示されないとき
BYOKの表示と管理には権限が必要です。 権限がない場合、画面には表示されません。 組織またはプロジェクトが利用できる状態でない場合は、登録済みのキーを閲覧できても、登録・差し替え・停止はできません。
BYOKの秘密値はサーバー側で管理します。
推論リクエストのボディやクライアント設定へプロバイダーのAPIキーを含めないでください。
503 Service Unavailable が続く場合は、選択中のBYOK認証情報が有効か、対象プロジェクトで利用する設定になっているかを確認してください。