多模態API接入指南 - AI Guardrails

本文檔介紹了調用AI安全護欄多模態審核介面的方法。

步驟一：開通服務

前往AI安全護欄產品開通服務頁面，開通AI安全護欄產品服務。

步驟二：為RAM使用者授權

在接入SDK或者API之前，您需要為RAM使用者授權。您可以為阿里雲帳號和RAM使用者建立一個存取金鑰（AccessKey）。在調用阿里雲API時您需要使用AccessKey完成身分識別驗證。擷取方式，請參見擷取AccessKey。

操作步驟

使用阿里雲帳號登入RAM控制台。
建立RAM使用者。
具體操作，請參見建立RAM使用者。
向RAM使用者授權系統策略許可權：AliyunYundunGreenWebFullAccess。
具體操作，請參見管理RAM使用者的許可權。
完成以上配置後，您可以使用RAM使用者調用Alibaba Content Security ServiceAPI。

步驟三：安裝並接入SDK

AI安全護欄產品服務SDK請參考多模態SDK參考

API說明

使用說明

您可以調用該介面建立常值內容檢測任務。

業務介面：MultiModalGuard
支援的地區及接入地址：

地區	外網接入地址	內網接入地址
華東2（上海）	https://green-cip.cn-shanghai.aliyuncs.com	https://green-cip-vpc.cn-shanghai.aliyuncs.com
華北2（北京）	https://green-cip.cn-beijing.aliyuncs.com	https://green-cip-vpc.cn-beijing.aliyuncs.com
華東1（杭州）	https://green-cip.cn-hangzhou.aliyuncs.com	https://green-cip-vpc.cn-hangzhou.aliyuncs.com
華南1（深圳）	https://green-cip.cn-shenzhen.aliyuncs.com	https://green-cip-vpc.cn-shenzhen.aliyuncs.com
西南1（成都）	https://green-cip.cn-chengdu.aliyuncs.com	暫無
新加坡	green-cip.ap-southeast-1.aliyuncs.com	green-cip-vpc.ap-southeast-1.aliyuncs.com

計費資訊：該介面為收費介面。僅對HTTP狀態代碼為200的請求進行計量計費，產生其他錯誤碼時不會計費。關於計費方式，請參見開通與計費概述部分。

重要

QPS限制：本介面的單使用者QPS限制為50次/秒(含有檔案模態時，預設限制為10次/秒)。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。

請求參數

名稱	類型	是否必須	樣本值	描述
Service	String	是	query_security_check_intl	AI輸入Alibaba Content Security Service檢測（query_security_check_intl） AI產生Alibaba Content Security Service檢測（response_security_check_intl）
ServiceParameters	JSONString	是		審核服務需要的參數集。JSON字串格式，關於每個字串的描述，請參見ServiceParameters。

表 1. ServiceParameters

名稱	類型	是否必須	樣本值	描述
content	String	至少傳入一項內容	文本檢測內容	審核的常值內容重要最大支援單次2000字元輸入
imageUrls	JSONArray		http://xxxx123	當前只支援一張圖片
fileUrls	JSONArray		http://xxxx456	當前只支援一個檔案重要檔案大小不超過10M
chatId	String	否（如選用流式審核，必須傳入該欄位）	ABC123	用於唯一標識一輪“使用者輸入 + 大模型輸出”的互動記錄
sessionId	String	否	14****	會話ID，標記本次請求內容屬於同一段流式內容，文本審核引擎會自動拼接後進行審核，審核拼接文字片段後不超過服務字數限制的部分。
done	Boolean	否（如選用流式審核，建議要傳該欄位）	true	true（標識該切片為本輪對話的終止標識） false（標識該切片非本輪對話的終止標識）
dataId	String	否	img123******	用於唯一標識檢測內容
accountId	String	否	13****	賬戶ID，標識一個賬戶的唯一ID。傳入帳號ID時會結合相同帳號ID的前後文進行審核。
ip	String	否	192.168.1.***	帳號ID的IP地址
referer	String	否	www.aliyun.com	referer要求標頭，用於防盜鏈等情境。長度不超過256個字元。
referenceContent	String	否	上下文內容	用於和待檢測內容進行對比，檢測模型幻覺的上下文內容。

返回參數

名稱	類型	樣本值	描述
Code	Integer	200	狀態代碼。更多資訊，請參見Code說明。
Data	JSONObject	{"Result":[...]}	審核結果資料，具體請參見Data。
Message	String	OK	請求訊息的響應訊息。
RequestId	String	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****	請求ID。

表 2. Data

名稱

類型

樣本值

描述

Detail

JSONArray

檢測的內容合規風險標籤、置信分等結果，具體請參見Detail。

Suggestion

String

Pass

審核建議

block 建議阻斷
pass 建議通過
watch 建議觀察
mask 建議脫敏

說明

目前僅敏感內容檢測支援觀察和脫敏，其他檢測維度均只支援阻斷或通過。
當您檢測多個維度時，我們會對每個維度Suggestion結果進行合并。合并優先順序由高到低的排序：block、mask、watch、pass。

表 3. Detail

名稱	類型	樣本值	描述
Suggestion	String	pass	審核建議 block 建議阻斷 pass 建議通過 watch 建議觀察 mask 建議脫敏說明目前僅敏感內容檢測支援觀察和脫敏，其他檢測維度均只支援阻斷或通過。當您檢測多個維度時，我們會對每個維度Suggestion結果進行合并。合并優先順序由高到低的排序：block、mask、watch、pass。
Type	String	contentSecurity	防護維度 contentModeration 內容合規檢測 promptAttack 提示詞攻擊檢測 sensitiveData 敏感內容檢測 modelHallucination 模型幻覺
Level	String	high	風險等級，根據設定的高低風險分返回，傳回值包括： high：高風險（若命中自訂詞庫，風險等級預設為高風險） medium：中風險 low：低風險 none：未檢測到風險說明高風險內容建議直接處置；中風險內容建議人工複查；低風險內容建議在高召回需求時再做處理，日常建議和未檢測到風險做相同處理。風險分值可以在登入AI安全護欄產品控制台配置。敏感等級（for SensitiveData），傳回值包括： S0、S1、S2、S3 S0代表未檢出敏感內容數字越高敏感程度越高
Result	JSONArray		檢測的內容合規風險標籤、置信分等結果，具體請參見Result。

表 4. Result

名稱	類型	樣本值	描述
Description	String	疑似政治實體	對Labal欄位的說明。重要該欄位為Label欄位的解釋說明，可能會變更調整，實際處理結果時建議處理Label欄位，不要基於該欄位進行結果處置。
Confidence	Float	81.22	置信分值，0到100分，保留到小數點後2位。部分標籤無置信分。
Label	String	political_xxx	文字內容檢測運算後返回的標籤，可能會檢出多個標籤和分值。
Level	String	high	風險等級，根據設定的高低風險分返回，傳回值包括： high：高風險（若命中自訂詞庫，風險等級預設為高風險） medium：中風險 low：低風險 none：未檢測到風險說明高風險內容建議直接處置；中風險內容建議人工複查；低風險內容建議在高召回需求時再做處理，日常建議和未檢測到風險做相同處理。風險分值可以在登入AI安全護欄產品控制台配置。敏感等級（for SensitiveData），傳回值包括： S0、S1、S2、S3 S0代表未檢出敏感內容數字越高敏感程度越高
Ext	JSONObject		部分防護維度會返回相應的擴充資訊，具體請參見Ext。

表 5. Ext

名稱	類型	樣本值	描述
Riskwords	String	AA,BB,CC	適用防護維度： contentModeration 內容合規檢測檢測到的敏感詞，多個詞用逗號分隔，部分標籤不會返回敏感詞。
CustomizedHit	JSONArray	[{"LibName":"...","Keywords":"..."}]	適用防護維度： contentModeration 內容合規檢測當命中自訂庫時，Label為customized，返回自訂庫名稱和自訂詞。
SensitiveData	JSONArray	["6201112223455"]	適用防護維度： sensitiveData 敏感內容檢測檢出敏感樣本
Desensitization	String	...【手機號碼】是我的連絡方式...	適用防護維度： sensitiveData 敏感內容檢測脫敏後的內容
FileUrl	String	https://sase-public-server-files.oss-cn-hangzhou.aliyuncs.com/saas-XXX	適用防護維度： waterMark 數字浮水印標識含浮水印檔案下載連結
OutFileSize	String	152357	適用防護維度： waterMark 數字浮水印標識檔案大小
FileUrlExp	String	1754135551	適用防護維度： waterMark 數字浮水印標識含浮水印檔案下載連結失效時間
Filename	String	B7VKehJ4gZR.png	適用防護維度： waterMark 數字浮水印標識檔案名稱
OutFileHashMd5	String	8b96ff73e8d8060016bb41b16d337871	適用防護維度： waterMark 數字浮水印標識檔案MD5標識

表 6. CustomizedHit

名稱	類型	樣本值	描述
LibName	String	自訂庫1	自訂庫名稱
Keywords	String	自訂詞1,自訂詞2	自訂詞，多個詞用逗號分隔。

樣本

請求樣本

{
  "Service": "XXX",
  "ServiceParameters": {
    "content": "testing content",
    "chatId": "ABC123",
    "dataId": "img123******",
    "accountId":"abc",
    "sessionId":"abc",
    "imageUrls": ["http://xxxx"], # 當前只支援一張圖片
    "fileUrls": ["http://xxxx"], # 當前只支援一個檔案
    "referer": "http://www.aliyun.com",
    "referenceContent":"用於幻覺檢測的上下文內容"
  }
}

返回樣本：

檢測query_security_check，命中系統策略：

{
  "Code": 200,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "Message": "OK",
  "Data": {
    "Suggestion": "block",
    "Detail": [
      {
        "Suggestion": "mask",
        "Type": "sensitiveData",
        "Level": "S2",
        "Result": [
          {
            "Ext": {
              "Desensitization": "...【手機號碼】我的連絡方式...",
              "SensitiveData": [
                "136********"
              ]
            },
            "Description": "手機號（中國內地）",
            "Label": "1814",
            "Level": "S2"
          },
          {
            "Ext": {
              "SensitiveData": [
                "**市"
              ]
            },
            "Description": "城市（中國內地）",
            "Label": "1739",
            "Level": "S0"
          }
        ]
      },
      {
        "Suggestion": "block",
        "Type": "promptAttack",
        "Level": "high",
        "Result": [
          {
            "Description": "拒絕抑制越獄",
            "Confidence": 100,
            "Label": "Refusal Supression Jailbreak",
            "Level": "high"
          }
        ]
      },
      {
        "Suggestion": "block",
        "Type": "contentModeration",
        "Level": "high",
        "Result": [
          {
            "Description": "疑似政治實體",
            "Confidence": 100,
            "Label": "political_entity",
            "Level": "high"
          },
          {
            "Ext": {
              "CustomizedHit": [
                {
                  "LibName": "需加黑攔截",
                  "KeyWords": "詞a,詞b,詞c"
                }
              ]
            },
            "Description": "命中自訂庫",
            "Confidence": 100,
            "Label": "customized",
            "Level": "high"
          }
        ]
      },
      {
        "Result": [
          {
            "Description": "內在幻覺",
            "Confidence": 95,
            "Label": "Intrinsic Hallucination",
            "Level": "medium"
          }
        ],
        "Type": "modelHallucination",
        "Suggestion": "block",
        "Level": "medium"
      }
    ]
  }
}

檢測img_response_security_check，命中系統策略：

  {
  "Code": 200,
  "Data": {
    "Detail": [
      {
        "Level": "none",
        "Result": [
          {
            "Confidence": 0.0,
            "Description": "未檢測出風險",
            "Ext": {
              "FileUrl": "https://sase-public-server-files.oss-cn-hangzhou.aliyuncs.com/saas-XXX",
              "OutFileSize": 527918,
              "FileUrlExp": "1754200240",
              "Filename": "wJGz6kmZ1Ce.jpg",
              "OutFileHashMd5": "02f5129f606027c7a87b84377ec98f8e"
            },
            "Label": "nonLabel",
            "Level": "none"
          }
        ],
        "Suggestion": "pass",
        "Type": "waterMark"
      },
      {
        "Level": "high",
        "Result": [
          {
            "Confidence": 90,
            "Description": "違反廣告法-極限詞",
            "Label": "ad_Compliance_WordLimit_Tii",
            "Level": "high"
          }
        ],
        "Suggestion": "block",
        "Type": "contentModeration"
      }
    ],
    "Suggestion": "block"
  },
  "Msg": "OK"
}

檢測text_img_security_check，命中系統策略：

{
  "Code": 200,
  "Data": {
    "Detail": [
      {
        "Ext": {},
        "Level": "high",
        "Result": [
          {
            "Confidence": 98.34,
            "Description": "女性乳溝",
            "Label": "sexual_Cleavage",
            "Level": "high"
          }
        ],
        "Suggestion": "block",
        "Type": "contentModeration"
      }
    ],
    "Suggestion": "block"
  },
  "Msg": "OK"
}

檢測file_security_sync_check，命中系統策略：

{
  "Code": 200,
  "Data": {
    "Detail": [
      {
        "Ext": {},
        "Level": "high",
        "Result": [
          {
            "Confidence": 100,
            "Description": "網站後門",
            "Label": "WebShell",
            "Level": "high"
          }
        ],
        "Suggestion": "block",
        "Type": "maliciousFile"
      },
      {
        "Ext": {
          "PageSum": 1
        },
        "Level": "none",
        "Result": [
          {
            "Description": "未檢測出風險",
            "Label": "nonLabel",
            "Level": "none"
          }
        ],
        "Suggestion": "pass",
        "Type": "contentModeration"
      }
    ],
    "Suggestion": "block"
  },
  "Msg": "OK"
}

檢測text_file_sec_sync_check，命中系統策略：

{
  "Code": 200,
  "Data": {
    "Detail": [
      {
        "Ext": {
          "PageSum": 4
        },
        "Level": "none",
        "Result": [
          {
            "Description": "未檢測出風險",
            "Label": "nonLabel",
            "Level": "none"
          }
        ],
        "Suggestion": "pass",
        "Type": "contentModeration"
      }
    ],
    "Suggestion": "pass"
  },
  "Msg": "OK"
}

Code說明

Code	狀態碼	說明
200	OK	請求成功。
400	BAD_REQUEST	請求有誤。可能是請求參數不正確導致，請仔細檢查請求參數。
408	PERMISSION_DENY	可能是您的帳號未授權、帳號欠費、帳號未開通、帳號被禁等。
500	GENERAL_ERROR	錯誤。可能是服務端臨時出錯。建議重試，若持續返回該錯誤碼，請通過線上服務聯絡我們。
581	TIMEOUT	逾時。建議重試，若持續返回該錯誤碼，請通過線上服務聯絡我們。
588	EXCEED_QUOTA	請求頻率超出配額。、