調用TextModerationPlus介面審核常值內容-Alibaba Content Security Service-阿里雲

本文檔介紹了調用AI安全護欄介面審核常值內容的方法。

重要

如果您之前已經對接過Alibaba Content Security Service文本審核增強版PLUS服務，僅需完成SDK版本升級即可調通本介面。
如果您之前未對接過Alibaba Content Security Service文本審核增強版PLUS服務，我們強烈建議您直接對接多模態API介面。如果後續您還有AIGC圖片、檔案等內容的審核需求，可直接複用該多模態介面。具體請參考多模態API接入指南

步驟一：開通服務

前往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說明

使用說明

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

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

地區	外網接入地址	內網接入地址
新加坡	green-cip.ap-southeast-1.aliyuncs.com	green-cip-vpc.ap-southeast-1.aliyuncs.com

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

QPS限制

本介面的單使用者QPS限制為50次/秒。超過限制，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字元輸入
chatId	String	否	ABC123	用於唯一標識一輪“使用者輸入 + 大模型輸出”的互動記錄

返回參數

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

表 2. Data

名稱	類型	樣本值	描述
Result	JSONArray		檢測的內容合規風險標籤、置信分等結果，具體請參見Result。
RiskLevel	String	high	風險等級，根據設定的高低風險分返回，傳回值包括： high：高風險（若命中自訂詞庫，風險等級預設為高風險） medium：中風險 low：低風險 none：未檢測到風險說明高風險內容建議直接處置；中風險內容建議人工複查；低風險內容建議在高召回需求時再做處理，日常建議和未檢測到風險做相同處理。風險分值可以在登入AI安全護欄產品控制台配置。
SensitiveResult	JSONArray		檢測的敏感內容風險標籤、敏感樣本等結果，具體請參見SensitiveResult
SensitiveLevel	String	S4	敏感等級，傳回值包括： S0、S1、S2、S3、S4 S0代表未檢出敏感內容數字越高敏感程度越高
AttackResult	JSONArray		檢測的攻擊內容風險標籤、置信分等結果，具體請參見AttackResult
AttackLevel	String	high	攻擊等級，傳回值包括： high：高風險 medium：中風險 low：低風險 none：未檢測到風險

表 3. Result

名稱	類型	樣本值	描述
Label	String	political_xxx	文字內容檢測運算後返回的標籤，可能會檢出多個標籤和分值。
Confidence	Float	81.22	置信分值，0到100分，保留到小數點後2位。部分標籤無置信分。
Riskwords	String	AA,BB,CC	檢測到的敏感詞，多個詞用逗號分隔，部分標籤不會返回敏感詞。
CustomizedHit	JSONArray	[{"LibName":"...","Keywords":"..."}]	當命中自訂庫時，Label為customized，返回自訂庫名稱和自訂詞。
Description	String	疑似政治實體	對Labal欄位的說明。重要該欄位為Label欄位的解釋說明，可能會變更調整，實際處理結果時建議處理Label欄位，不要基於該欄位進行結果處置。

表 4. CustomizedHit

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

表 5. SensitiveResult

名稱	類型	樣本值	描述
Label	String	1780	文字內容檢測運算後返回的標籤，可能會檢出多個標籤和分值。
SensitiveLevel	String	S4	敏感等級，傳回值包括： S0、S1、S2、S3 S0代表未檢出敏感內容數字越高敏感程度越高
SensitiveData	JSONArray	["6201112223455"]	檢出敏感樣本（0-5個）
Description	String	信用卡號	對Labal欄位的說明。重要該欄位為Label欄位的解釋說明，可能會變更調整，實際處理結果時建議處理Label欄位，不要基於該欄位進行結果處置。

表 6. AttackResult

名稱	類型	樣本值	描述
Label	String	Indirect Prompt Injection	文字內容檢測運算後返回的標籤，可能會檢出多個標籤和分值。
AttackLevel	String	high	攻擊等級，傳回值包括： high：高風險 medium：中風險 low：低風險 none：未檢測到風險
Confidence	Float	100.0	置信分值，0到100分
Description	String	間接提示詞注入	對Labal欄位的說明。重要該欄位為Label欄位的解釋說明，可能會變更調整，實際處理結果時建議處理Label欄位，不要基於該欄位進行結果處置。

樣本

請求樣本

{
    "Service": "query_security_check",
    "ServiceParameters": {
        "content": "testing content",
        "chatId":"ABC123"
    }
}

返回樣本：

命中系統策略：

{
    "Code": 200,
    "Data": {
        "Result": [
            {
                "Label": "political_entity",
                "Description":"疑似政治實體",
                "Confidence": 100.0,
                "RiskWords": "詞A,詞B,詞C"
            },
            {
                "Label": "political_figure",
                "Description":"疑似政治人物",
                "Confidence": 100.0,
                "RiskWords": "詞A,詞B,詞C"
            }
            {
                "Label": "customized",
                "Description": "命中自訂庫",
                "Confidence": 100.0,
                "CustomizedHit": [
                     {
                        "LibName": "自訂詞庫名稱1",
                        "KeyWords": "自訂關鍵詞"
                     }
                ]
             }
        ],
         "SensitiveResult": [
            {
                "Label": "1780",
                "SensitiveLevel": "S4",
                "Description":"信用卡號",
                "SensitiveData": ["6201112223455"]
            }
        ],     
         "AttackResult": [
            {
                "Label": "Indirect Prompt Injection",
                "AttackLevel": "high", 
                "Description":"間接提示詞注入",
                "Confidence": 100.0
            }
        ],   
        "RiskLevel": "high",
        "SensitiveLevel": "S3",
        "AttackLevel": "high",                      
    },
    "Message": "OK",
    "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****"
}

Code說明

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