Skip to Content
APIリファレンスルールルール一覧

ルール一覧

GET/console/v1/accounts/{accountId}/projects/{projectId}/rules

プロジェクトのルールの一覧を取得します。

認証

Authorizationstring必須

Bearer <マネジメントトークン> の形式で指定します。 詳しくは認証を参照してください。

パスパラメーター

accountIdstring必須

組織のID。 コンソールのURLの /accounts/ に続く部分です。

projectIdstring必須

プロジェクトのID。 プロジェクト一覧の projectId で取得できます。

レスポンス

viewerobject

マネジメントトークンの発行者の情報。

フィールドを表示フィールドを非表示
humanPrincipalIdstring

発行者のメンバーID。

canManageboolean

ルールを管理できるかどうか。

rulesarray

ルールの配列。 作成日時の古い順に並びます。

フィールドを表示フィールドを非表示
ruleIdstring

ルールのID。

namestring

ルールの名前。

settingsobject

ルールの設定。 作成時または更新時に指定したフィールドだけを含みます。

フィールドを表示フィールドを非表示
maxBudgetMicroJpyinteger | null

予算の上限。 円の金額を1,000,000倍した整数で指定します(例:5,000円は 5000000000)。

budgetDurationstring | null

予算の期間。 day、week、month のいずれかを指定します。 指定する場合は、maxBudgetMicroJpy も必要です。 プロジェクト設定の 1d、1w、1mo とは書き方が異なります。

rpmLimitinteger | null

1分あたりのリクエスト数(RPM)の上限。

tpmLimitinteger | null

1分あたりのトークン数(TPM)の上限。

modelsstring[]

利用を許可するモデルのID(UUID)の配列。 推論APIの model に指定するIDとは異なります。 空の場合は、組織で許可されているすべてのモデルを利用できます。

autoCandidatesstring[]

model に auto を指定したときに、候補にするモデルのID(UUID)の配列。

routingStrategystring | null

auto の候補から選ぶ方法。 cheapest を指定すると、価格の安い順に選びます。

fallbackModelsstring[]

指定したモデルが応答できない場合に、代わりに試すモデルのID(UUID)の配列。 詳しくはフォールバックを参照してください。

forceAutoboolean

auto 以外のモデルの指定を拒否するかどうか。

guardrailsarray

リクエストをモデルへ送る前に行う検査(ガードレール)。 pii_mask(個人情報の置き換え)、prompt_injection(プロンプトインジェクションの拒否)を指定できます。 詳しくはガードレールを参照してください。

createdAtstring

作成日時(ISO 8601)。

appliedKeyCountinteger

このルールを適用しているAPIキーの数。

エラー

エラーの形式はエラーを参照してください。

ステータスコードerror原因
401console_authentication_failedマネジメントトークンが正しくない、または有効期限が切れている
403console_authorization_denied操作する権限がない
404not_foundリソースが見つからない、またはIDの形式が正しくない
503console_key_rules_unavailableサービスが一時的に利用できない