檢視次數:
使用本指南將 AI Guard API 整合到您的應用程式中，以偵測策略違規和有風險的互動。請參閱AI Guard API 參考文件以獲取詳細資訊。

標頭

名稱
必要
描述
Authorization
是
用於驗證的持有者令牌。使用格式Bearer {token}添加Trend Vision One API 金鑰。
TMV1-Application-Name
是
正在評估提示的AI應用程式名稱。必須僅包含字母、數字、連字號和底線。最大長度為64個字元。範例：my-ai-application
TMV1-Request-Type
No
正在評估的請求類型。決定如何解析請求正文。
可能的值：
  • SimpleRequestGuard：簡單提示字串（預設）
  • OpenAIChatCompletionRequestV1：OpenAI 聊天完成請求格式
  • OpenAIChatCompletionResponseV1：OpenAI 聊天完成回應格式
Prefer
No
控制回應的詳細程度。
可能的值：
  • return=minimal：返回僅包含審核動作和高層次原因的簡短回應（預設）
  • return=representation：返回審核結果的 JSON 表示，包括動作、高層次原因以及每個類別分類的中繼資料，例如標記和信心水準

查詢參數

名稱
必要
描述
detailedResponse
No
API 回應的詳細程度。
可能的值包括：
  • false：根據AI Guard設定（預設）對您的提示進行簡短評估。
  • true：根據AI Guard設定對您提示進行詳細評估。

要求

OpenAI 聊天完成請求格式當 TMV1-Request-Type 是 OpenAiChatCompletionRequestV1：
{
  "model": "us.meta.llama3-1-70b-instruct-v1:0",
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": "Your prompt text here"
    }
  ]
}
OpenAI 聊天完成回應格式當 TMV1-Request-Type 是 OpenAIChatCompletionResponseV1：
{
  "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
  }
}
當 TMV1-Request-Type 是 SimpleRequstGuardrails 或未指定時的簡單提示格式：
{
  "prompt": "Your prompt text here"
}

回應

當 Prefer 是 return-minimal 或未指定時的簡短回應：
{
    "id": "1234567890abcdef",
    "action": "Block",
    "reasons": [
      "Harmful Scanner exceeding threshold: H,V"
    ]
  }
當 Prefer 是 return=representation 時的較長回應：
{
    "id": "1234567890abcdef",
    "action": "Allow",
    "reasons": [],
    "harmfulContent": [
      {
        "category": "Sexual",
        "hasPolicyViolation": false,
        "confidenceScore": 0.05
      }
      {
        "category": "Hate",
        "hasPolicyViolation": false,
        "confidenceScore": 0.02
      }
      {
        "category": "Violence",
        "hasPolicyViolation": false,
        "confidenceScore": 0.01
      }
      {
        "category": "Harassment",
        "hasPolicyViolation": false,
        "confidenceScore": 0.03
      }
      {
        "category": "Self-harm",
        "hasPolicyViolation": false,
        "confidenceScore": 0.01
      }
      {
        "category": "Sexual/minors",
        "hasPolicyViolation": false,
        "confidenceScore": 0.00
      }
      {
        "category": "Hate/threatening",
        "hasPolicyViolation": false,
        "confidenceScore": 0.01
      }
      {
        "category": "Violence/graphic",
        "hasPolicyViolation": false,
        "confidenceScore": 0.02
      }
    ],
    "sensitiveInformation": {
      "hasPolicyViolation": false,
      "rules": []
    },
    "promptAttacks": [
      {
        "hasPolicyViolation": false,
        "confidence_score": 0.02
      },
      {
        "hasPolicyViolation": false,
        "confidence_score": 0.01
      }
    ]
  }

回應參數

參數
描述
id
AI Guard 評估的唯一識別碼。
action
建議的操作。
可能的值：
  • Allow
  • Block
reasons
該操作的說明，包括設定違規的詳細資訊。
harmfulContent
在輸入或輸出中檢測到任何有害內容，並附有信心分數。僅提供詳細回應。
sensitiveInformation
任何與個人識別資訊（PII）或敏感資訊相關的檢測違規行為。僅提供詳細回應。
promptAttacks
檢測到的任何提示攻擊的陣列，包含信心分數。僅提供詳細回應。

常見錯誤

API 返回標準 HTTP 狀態碼：
  • 400 錯誤的請求：請檢查錯誤訊息以獲取詳細資訊
  • 403 禁止存取：使用者權限不足或驗證問題
  • 429 請求過多：超出速率限制
  • 500 內部伺服器錯誤：伺服器端發生暫時性問題

程式碼範例

請參閱以下範例程式碼，以整合 AI Guard 至不同語言中：