ビュー:

ヘッダ

名前
必須
説明
Authorization
はい
認証用のベアラートークン。

クエリパラメータ

名前
必須
説明
detailedResponse
No
API対応の詳細レベル。
考えられる値は次のとおりです:
  • false: AIガード設定 (デフォルト) に基づくプロンプトの簡単な評価。
  • true: AIガード設定に基づくプロンプトの詳細な評価。

要求

OpenAIチャット完了リクエスト形式:
{
  "model": "us.meta.llama3-1-70b-instruct-v1:0",
  "messages": [
    {
      "role": "user",
      "content": "Your prompt text here"
    }
  ]
}
OpenAIチャット完了対応形式:
{
  "id": "chatcmpl-8f88f71a-7d42-c548-d587-8fc8a17091b6",
  "object": "chat.completion",
  "created": 1748535080,
  "model": "us.meta.llama3-1-70b-instruct-v1:0",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Response content here",
        "refusal": null
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 139,
    "completion_tokens": 97,
    "total_tokens": 236
  }
}
シンプルな文字列形式:
{
  "guard": "Your prompt text here"
}

対応

サンプル対応 (detailedResponse: falseの場合):
{
    "id": "1234567890abcdef",
    "action": "Block",
    "reason": "[Violation] Policy Name: harmful_content"
  }
サンプル対応 (detailedResponse: trueの場合):
{
    "id": "1234567890abcdef",
    "action": "Allow",
    "reason": "No policy violations detected",
    "harmful_content": [
      {
        "name": "harmful_content",
        "content_violation": false,
        "confidence_score": 0.05
      }
    ],
    "sensitive_information": {
      "content_violation": false,
      "rule": ""
    },
    "prompt_attack": [
      {
        "name": "prompt_injection",
        "content_violation": false,
        "confidence_score": 0.02
      }
    ]
  }
パラメータ
説明
id
AIガード評価の一意の識別子。
action
推奨アクション。
考えられる値は次のとおりです:
  • Allow
  • ブロック
reason
アクションの説明、設定違反の詳細を含む。
harmful_content
入力または出力で検出された有害なコンテンツと信頼スコア。
sensitive_information
個人を特定できる情報 (PII) または機密情報に関連する検出された違反。
prompt_attack
検出されたすべてのプロンプト攻撃の配列と、信頼度スコア。

一般的なエラー

APIは標準HTTPステータスコードを返します。
  • 400 不正なリクエスト: 詳細はエラーメッセージを確認してください
  • 403 禁止: ユーザの権限が不十分、または認証の問題
  • 429 リクエストが多すぎます: レート制限を超えました
  • 500内部サーバーエラー: サーバ側で一時的な問題が発生しました
関連情報