ルールの更新
/console/v1/accounts/{accountId}/projects/{projectId}/rules/{ruleId}ルールの名前または設定を更新します。
settings を指定すると、設定全体が置き換わります。変更しない項目も含めて、すべて指定してください。
更新した設定は、このルールを適用しているAPIキーにも反映されます。
認証
Authorizationstring必須Bearer <マネジメントトークン> の形式で指定します。
詳しくは認証を参照してください。
パスパラメーター
accountIdstring必須組織のID。
コンソールのURLの /accounts/ に続く部分です。
projectIdstring必須プロジェクトのID。
プロジェクト一覧の projectId で取得できます。
ruleIdstring必須ルールのID。
ルール一覧の ruleId で取得できます。
リクエストボディ
name と settings のどちらか、または両方を指定します。
namestringルールの名前。 1〜100文字で指定します。
settingsobjectルールの設定。 省略したフィールドは、ルールから削除されます。
フィールドを表示フィールドを非表示
maxBudgetMicroJpyinteger | null予算の上限。
円の金額を1,000,000倍した整数で指定します(例:5,000円は 5000000000)。
budgetDurationstring | null予算の期間。
day、week、month のいずれかを指定します。
指定する場合は、maxBudgetMicroJpy も必要です。
プロジェクト設定の 1d、1w、1mo とは書き方が異なります。
rpmLimitinteger | null1分あたりのリクエスト数(RPM)の上限。
tpmLimitinteger | null1分あたりのトークン数(TPM)の上限。
modelsstring[]利用を許可するモデルのID(UUID)の配列。
推論APIの model に指定するIDとは異なります。
空の場合は、組織で許可されているすべてのモデルを利用できます。
autoCandidatesstring[]model に auto を指定したときに、候補にするモデルのID(UUID)の配列。
routingStrategystring | nullauto の候補から選ぶ方法。
cheapest を指定すると、価格の安い順に選びます。
fallbackModelsstring[]指定したモデルが応答できない場合に、代わりに試すモデルのID(UUID)の配列。 詳しくはフォールバックを参照してください。
forceAutobooleanauto 以外のモデルの指定を拒否するかどうか。
guardrailsarrayリクエストをモデルへ送る前に行う検査(ガードレール)。
pii_mask(個人情報の置き換え)、prompt_injection(プロンプトインジェクションの拒否)を指定できます。
詳しくはガードレールを参照してください。
レスポンス
ruleobject更新後のルール。
フィールドを表示フィールドを非表示
ruleIdstringルールのID。
namestringルールの名前。
settingsobjectルールの設定。 作成時または更新時に指定したフィールドだけを含みます。
フィールドを表示フィールドを非表示
maxBudgetMicroJpyinteger | null予算の上限。
円の金額を1,000,000倍した整数で指定します(例:5,000円は 5000000000)。
budgetDurationstring | null予算の期間。
day、week、month のいずれかを指定します。
指定する場合は、maxBudgetMicroJpy も必要です。
プロジェクト設定の 1d、1w、1mo とは書き方が異なります。
rpmLimitinteger | null1分あたりのリクエスト数(RPM)の上限。
tpmLimitinteger | null1分あたりのトークン数(TPM)の上限。
modelsstring[]利用を許可するモデルのID(UUID)の配列。
推論APIの model に指定するIDとは異なります。
空の場合は、組織で許可されているすべてのモデルを利用できます。
autoCandidatesstring[]model に auto を指定したときに、候補にするモデルのID(UUID)の配列。
routingStrategystring | nullauto の候補から選ぶ方法。
cheapest を指定すると、価格の安い順に選びます。
fallbackModelsstring[]指定したモデルが応答できない場合に、代わりに試すモデルのID(UUID)の配列。 詳しくはフォールバックを参照してください。
forceAutobooleanauto 以外のモデルの指定を拒否するかどうか。
guardrailsarrayリクエストをモデルへ送る前に行う検査(ガードレール)。
pii_mask(個人情報の置き換え)、prompt_injection(プロンプトインジェクションの拒否)を指定できます。
詳しくはガードレールを参照してください。
createdAtstring作成日時(ISO 8601)。
appliedKeyCountintegerこのルールを適用しているAPIキーの数。
エラー
エラーの形式はエラーを参照してください。
| ステータスコード | error | 原因 |
|---|---|---|
400 | bad_request | リクエストボディの形式や値が正しくない、または指定したモデルを利用できない |
401 | console_authentication_failed | マネジメントトークンが正しくない、または有効期限が切れている |
403 | console_authorization_denied | 操作する権限がない、または組織やプロジェクトが有効な状態ではない |
404 | not_found | リソースが見つからない、またはIDの形式が正しくない |
409 | rule_name_conflict | 同じ名前のルールがすでにある |
503 | console_key_rules_unavailable | サービスが一時的に利用できない |