Skip to main content
Content-Type: application/jsonPOST https://bastion-guardian-api.starfort.io/v1/guard/api を呼び出します。

フィールド

リクエストでは camelCaseprocessTypeadditionalData)を使用します。これらは本番 API が期待するフィールド名です。

processType

processTypeGuardian が定義する自由形式のラベルであり、固定された列挙型ではありません。ほとんどの Guardian は input(入力時のリクエストをガード)と output(出力時のモデルレスポンスをガード)を宣言しますが、Guardian はサポートする任意の名前を宣言できます。
  • 大文字小文字を区別しません — 値はマッチング前にトリムされて小文字化されるため、"input""INPUT"" Input " は同じ呼び出しです。
  • 値は呼び出される Guardian がサポートするもののいずれかでなければなりません。 そうでない場合、呼び出しは事前検証中に拒否され、エラーメッセージにサポートされているプロセスタイプが一覧表示されます。エラーと状態を参照してください。
  • 一部のプロセスタイプはポリシー不要です(Guardian がそれらに対して互換性のあるポリシータイプを宣言しません)。これらは Guard Policy なしで実行され、完全に additionalData によって駆動されます。

additionalData

additionalData は、プロセスタイプが必要とする追加入力のための標準的なスロットです。Starfort は、Guardian 上で設定された値とあなたが送信する値をマージし(キーが競合した場合はあなたの値が優先)、その結果を変更せずに Guardian へ渡します。これは自由形式の JSON です(JSON として妥当かどうかのみがチェックされます)。たとえば、ポリシー不要のプロセスタイプは、その評価の基準として { "check_criteria": [...] } を受け取る場合があります。

メッセージのロール — 検査されるのは user のみ

各メッセージには role があります。Guardian は user メッセージのみを検査します。それ以外はコンテキストとして保持されますが、マスクやブロックは一切行われません。 user メッセージがないリクエストはチェックされずに通過します。ガードしたいコンテンツは必ず user ロールで送信してください。

Opticon トレーシング(オプション)

opticon オブジェクトは、その呼び出しに対して Starfort が記録するトレースにトレーシングメタデータを付加します。 あなたのフィールドに加えて、Starfort は各トレースを自動的に補強します。トレースの名前は Project Guardian の名前になり、ルートの action、各 policy_type:action / policy_name:action、および API キーの名前タグとして追加されます。processType、マスクされた API キー識別子、および解決された Model Configuration はメタデータになり、ポリシーごとの検出件数はスコアとして記録されます。キーが競合した場合はシステム値が優先されます。トレーシングはベストエフォートであり、呼び出しをブロックすることは決してありません。Opticon モニタリングを参照してください。 messages 内のマルチモーダルコンテンツ(画像、音声、ファイル、動画)については、マルチモーダル入力を参照してください。