API功能介紹
圖片審核2.0版API用於識別映像中是否有違反網路內容傳播相關規定、影響平台內容秩序、影響使用者體驗的內容或元素,支援40+的內容風險標籤和40+風險管控項。通過Alibaba Content Security Service的圖片審核2.0版,您可以根據業務所處的行業情境規範或平台內容治理規則,基於API返回的豐富的風險標籤和置信分,對具體圖片內容制定進一步的審核或治理措施。更多介紹,請參見圖片審核增強版2.0版介紹及計費說明。
接入指引
註冊阿里雲帳號:立即註冊,按照操作提示完成帳號註冊。
開通Alibaba Content Security Service隨用隨付:請確保您已開通服務,開通不收費,介面接入使用後系統會按使用量自動出賬,詳情請參見計費說明。
建立AccessKey:請確保您已通過RAM建立AccessKey,如果您使用的是子帳號AccessKey,您需要通過主帳號給子帳號賦予AliyunYundunGreenWebFullAccess許可權,具體操作,請參見RAM授權。
開發接入:推薦使用SDK方式調用,具體方法請詳見圖片審核增強版2.0版SDK及接入指南。
圖片審核增強版非同步檢測服務包含以下2個介面:
ImageAsyncModeration:提交圖片非同步審核任務
DescribeImageModerationResult:擷取審核任務結果
提交非同步檢測任務
使用說明
您可以調用該介面建立圖片內容檢測任務。關於如何構造HTTP請求,請參見HTTP原生調用;您也可以直接選用已構造好的HTTP請求,更多資訊,請參見接入指南。
業務介面:ImageAsyncModeration
支援的地區及接入地址:
地區
外網接入地址
內網接入地址
支援服務
新加坡
https://green-cip.ap-southeast-1.aliyuncs.com
https://green-cip-vpc.ap-southeast-1.aliyuncs.com
baselineCheck_global
計費資訊:
該介面為收費介面。僅對HTTP狀態代碼為200的請求進行計量計費,產生其他錯誤碼時不會計費。關於計費方式,請參見計費說明。
圖片要求:
圖片支援以下格式:PNG、JPG、JPEG、BMP、WEBP、TIFF、SVG、AVIF、HEIF(該格式最長邊需小於8192 px)、GIF(取第一幀)、ICO(取最後一圖)。
圖片大小限制在20 MB以內,高或者寬不能超過30,000 px,且總像素不能超過2.5億 px。像素建議大於200*200(px),像素過低會影響Alibaba Content Security Service檢測演算法的效果。
圖片下載時間限制為3秒內,如果下載時間超過3秒,返回下載逾時。
返回結果:非同步檢測任務不會即時返回檢測結果,您需要通過callback或者輪詢的方式擷取檢測結果。檢測結果最長保留3天。
callback擷取檢測結果:提交非同步檢測任務時,在請求參數中傳入callback參數,用來自動接收檢測結果。
輪詢擷取檢測結果:提交非同步檢測任務時,無需傳入callback參數;提交非同步檢測任務後,調用結果查詢介面擷取檢測結果。非同步檢測當前為排隊檢測,結果會在24小時內檢測完畢。
QPS限制
本介面的單使用者QPS限制為100次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。如果您業務量級較大或者有緊急擴容需求需要更大QPS,請聯絡您的商務經理。
調試
在接入前,您也可以通過阿里雲OpenAPI線上調試圖片審核2.0版的介面,查看調用範例程式碼及SDK依賴資訊,方便概覽介面的使用方法和參數。
線上調試能力是基於當前登入帳號調用Alibaba Content Security Service的API介面,因此調用量會計入帳號的收費用量中。
請求參數
關於在請求中必須包含的公用請求參數,請參考公用參數。
請求body是一個JSON結構體,包含以下欄位:
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
Service | String | 是 | baselineCheck_global | 圖片檢測2.0版支援的檢測服務。取值:
說明 不同服務區別請參考服務說明。 |
ServiceParameters | JSONString | 是 | 內容檢測對象的相關參數集。JSON字串格式,關於每個字串的描述,請參見ServiceParameters。 |
表 1. ServiceParameters
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
imageUrl | String | 是。圖片審核增強版支援三種方式傳入圖片,請您選擇其中一種:
| https://img.alicdn.com/tfs/TB1U4r9AeH2gK0jSZJnXXaT1FXa-2880-480.png | 待檢測對象的URL,請確保該URL能通過公網訪問到,且URL地址長度不超過2048個字元。 說明 URL地址中不能包含中文,且一次請求請確保僅傳入1條URL。 |
ossBucketName | String | bucket_01 | 已授權OSS空間的Bucket名。 說明 使用OSS圖片內網地址時必須先使用阿里雲帳號(即主帳號)訪問雲資源訪問授權頁面進行AliyunCIPScanOSSRole的授權。 | |
ossObjectName | String | 2022023/04/24/test.jpg | 已授權OSS空間的檔案名稱。 說明 1、傳入OSS的原始檔案名,不支援再添加圖片參數處理,如需增加圖片處理參數請使用imageUrl地址。 2、檔案名稱有中文或空格按照原始傳入,不需要做URL編碼。 | |
ossRegionId | String | cn-beijing | OSS Bucket所在地區。 | |
dataId | String | 否 | img123**** | 檢測對象對應的資料ID。 由大小寫英文字母、數字、底線(_)、短劃線(-)、英文句號(.)組成,不超過64個字元,可以用於唯一標識您的業務資料。 |
callback | String | 否 | http://www.aliyundoc.com | 檢測結果回調通知您的URL,支援使用HTTP和HTTPS協議的地址。該欄位為空白時,您必須定時輪詢檢測結果。 callback介面必須支援POST方法、UTF-8編碼的傳輸資料,以及表單參數ReqId,Checksum和Content。 Alibaba Content Security Service按照以下規則和格式設定ReqId,Checksum和Content,調用您的callback介面返回檢測結果。
說明 您的服務端callback介面收到Alibaba Content Security Service推送的結果後,如果返回的HTTP狀態代碼為200,則表示接收成功,其他的HTTP狀態代碼均視為接收失敗。接收失敗時,Alibaba Content Security Service將最多重複推送3次檢測結果,直到接收成功。重複推送3次後仍未接收成功,則不再推送,建議您檢查callback介面的狀態。 |
seed | String | 否 | abc**** | 隨機字串,該值用於回調通知請求中的簽名。 由英文字母、數字、底線(_)組成,不超過64個字元。由您自訂,用於在接收到Alibaba Content Security Service的回調通知時校正請求由阿里雲Alibaba Content Security Service服務發起。 說明 當使用callback時,該欄位必須提供。 |
cryptType | String | 否 | SHA256 | 使用回調通知時(callback),設定對回調通知內容進行加密的演算法。Alibaba Content Security Service會將返回結果(由使用者uid + seed + content拼接的字串)按照您設定的密碼編譯演算法加密後,再發送到您的回調通知地址。取值:
|
interval | Integer | 否 | 1 | 截幀頻率,GIF圖、長圖檢測專用。只有該值存在時,才會對GIF圖和長圖進行截幀。
如果不傳該值,預設只會檢測GIF圖的第一幀、長圖會壓縮後檢測。 說明 interval 需要與 maxFrameNum 參數組合使用。例如,設定 interval 為2, maxFrameNum 為10,在檢測GIF圖、長圖時,將每2幀檢測1張圖,最多檢測10張圖,計費則按照實際檢測的數量計算。 |
maxFrameNum | Integer | 否 | 10 | 最大截幀數量,GIF圖、長圖檢測專用,預設值為10,代表最多截取10幀。 取值限制1~100。 如果interval* maxFrameNum 小於GIF圖、長圖所包含的圖片幀數量時,截幀間隔自動修改為GIF圖、長圖所包含的圖片幀數/ maxFrameNum,以提高整體檢測效果。 |
referer | String | 否 | www.aliyun.com | referer要求標頭,用於防盜鏈等情境。長度不超過256個字元。 |
infoType | String | 是 | customImage,textInImage | 需要擷取的輔助資訊內容,取值:
支援指定多個內容,以英文逗號分隔。例如, “customImage,textInImage”表示同時返回自訂圖庫和圖片中文字資訊。 說明 人物資訊、標識標誌資訊支援在審核類型為圖片審核進階的Service中返回。更多資訊,請參考Service說明。 |
返回資料
名稱 | 類型 | 樣本值 | 描述 | |
Code | Integer | 200 | 狀態代碼。更多資訊,請參見Code說明。 | |
Msg | String | OK | 請求訊息的響應訊息。 | |
RequestId | String | ABCD1234-1234-1234-1234-123**** | 請求ID。 | |
Data | Object | 檢測結果。 | ||
ReqId | String | ABCD1234-1234-1234-1234-123**** | 請求ID。可用於查詢審核任務結果。 | |
DataId | String | img123****** | 檢測對象對應的資料ID。 | |
樣本
請求樣本
{
"Service": "baselineCheck",
"ServiceParameters": {
"imageUrl": "https://img.alicdn.com/tfs/TB1Mq6ZmCslXu8jSZFuXXXg7FXa-1440-568.jpg",
"dataId": "img123******",
"interval": 1,
"maxFrameNum": 50
}
}返回樣本
{
"Msg": "OK",
"Code": 200,
"RequestId": "ABCD1234-1234-1234-1234-1234XYZ",
"Data": {
"ReqId": "ABCD1234-1234-1234-1234-1234XYZ",
"DataId": "img123******"
}
}擷取審核任務結果
介面說明
業務介面:DescribeImageModerationResult,表示擷取圖片審核增強版審核任務結果。
計費資訊:該介面不計費。
查詢逾時:建議您將查詢間隔設定為30秒(即在提交非同步檢測任務30秒之後查詢結果),最長不能超出3天,否則結果將會自動刪除。
QPS限制
本介面的單使用者QPS限制為100次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。
調試
在接入前,您也可以通過阿里雲OpenAPI線上調試擷取圖片審核增強版審核任務結果的介面,查看調用範例程式碼及SDK依賴資訊,方便概覽介面的使用方法和參數。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
ReqId | String | 是 | ABCD1234-1234-1234-1234-123**** | 請求ID。是指圖片審核增強版2.0版同步檢測API返回的RequestId欄位。 |
返回資料
名稱 | 類型 | 樣本值 | 描述 |
RequestId | String | ABCD1234-1234-1234-1234-123**** | 本次調用請求的ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。 |
Data | Object | 圖片內容檢測結果。更多資訊,請參見Data。 | |
Code | Integer | 200 | 狀態代碼。更多資訊,請參見Code說明。 |
Msg | String | OK | 本次請求的響應訊息。 |
表 2. Data
名稱 | 類型 | 樣本值 | 描述 |
Result | Array | 圖片檢測的風險標籤、置信分等參數結果。更多資訊,請參見Result。 | |
RiskLevel | String | high | 風險等級,根據設定的高低風險分返回,傳回值包括:
說明 高風險內容建議直接處置;中風險內容建議人工複查;低風險內容建議在高召回需求時再做處理,日常建議和未檢測到風險做相同處理。風險分值可以在Alibaba Content Security Service控制台配置。 |
DataId | String | img123****** | 檢測對象對應的資料ID。 說明 如果在檢測請求參數中傳入了dataId,則此處返回對應的dataId。 |
FrameNum | Integer | 10 | 圖片返回總截幀數。 |
Frame | String | [{\"Result\":[{\"Confidence\":98.88,\"Label\":\"contraband_gamble\"}],\"TempUrl\":\"http://www.aliyundoc.com/test1.jpg\"}] | 圖片截幀資訊的JSON字串。包含以下欄位:
說明 當圖片未截幀時僅返回當前圖片資訊;當動圖和長圖存在截幀時會返回每1張截幀的資訊。 |
表 3. Result
名稱 | 類型 | 樣本值 | 描述 |
Label | String | violent_explosion | 圖片內容檢測運算後返回的標籤。同一張圖片可能會檢出多個標籤和分值。支援的標籤,請參見: |
Confidence | Float | 81.22 | 置信分值,0到100分,保留到小數點後2位。部分標籤無置信分,更多資訊,請參見風險標籤釋義表。 |
Description | String | 煙火類內容 | 對Labal欄位的說明。 重要 該欄位為Label欄位的解釋說明,可能會變更調整,實際處理結果時建議處理Label欄位,不要基於該欄位進行結果處置。 |
樣本
請求樣本
{
"ReqId": "ABCD1234-1234-1234-1234-123****"
}返回樣本
系統檢測到風險內容時,返回樣本:
{ "Msg": "success", "Code": 200, "Data": { "DataId": "img123****", "Result": [ { "Label": "pornographic_adultContent", "Confidence": 81, "Description": "成人色情" }, { "Label": "sexual_partialNudity", "Confidence": 98, "Description": "肢體裸露或性感" }, { "Label": "violent_explosion", "Confidence": 70, "Description": "煙火類內容" }, { "Label": "violent_explosion_lib", "Confidence": 81, "Description": "煙火類內容_命中自訂庫" } ], "RiskLevel": "high", "Frame": "[{\"Result\":[{\"Confidence\":98.18,\"Label\":\"contraband_gamble\"},{\"Confidence\":96.39,\"Label\":\"pornographic_adultContent\"},{\"Confidence\":95.27,\"Label\":\"violent_explosion\"}],\"TempUrl\":\"http://www.aliyundoc.com/test1.jpg\"},{\"Result\":[{\"Confidence\":91.18,\"Label\":\"violent_explosion_lib\"}],\"TempUrl\":\"http://www.aliyundoc.com/test2.jpg\"}]", "FrameNum": 2 }, "RequestId": "ABCD1234-1234-1234-1234-123****" }當系統沒有檢測到風險內容時,返回樣本:
{ "Msg": "success", "Code": 200, "Data": { "DataId": "img123****", "Result": [ { "Label": "nonLabel", "Confidence": null, "Description": "未檢測出風險" } ], "RiskLevel": "none", "Frame": "[{\"Result\":[{\"Label\":\"nonLabel\"}],\"TempUrl\":\"http://www.aliyundoc.com/test1.jpg\"},{\"Result\":[{\"Label\":\"nonLabel\"}],\"TempUrl\":\"http://www.aliyundoc.com/test2.jpg\"}]", "FrameNum": 2 }, "RequestId": "ABCD1234-1234-1234-1234-123****" }系統檢測到您傳入的圖片命中了您配置的免審圖庫時,返回樣本:
{ "Msg": "success", "Code": 200, "Data": { "DataId": "img123****", "Result": [ { "Label": "nonLabel_lib", "Confidence": 99.66, "Description": "命中免審圖庫" } ], "RiskLevel": "none", "Frame": "[{\"Result\":[{\"Confidence\":99.66,\"Label\":\"nonLabel_lib\"}],\"TempUrl\":\"http://www.aliyundoc.com/test1.jpg\"},{\"Result\":[{\"Confidence\":81.18,\"Label\":\"nonLabel_lib\"}],\"TempUrl\":\"http://www.aliyundoc.com/test2.jpg\"}]", "FrameNum": 2 }, "RequestId": "ABCD1234-1234-1234-1234-123****" }
文檔中的請求樣本和返回樣本為了便於閱讀,做了格式化處理,實際返回結果是沒有進行換行、縮排等處理。
風險標籤釋義表
Code說明
以下為介面返回code的含義說明,系統僅對code返回為200的請求計量計費,其他code不會計費。
Code | 說明 |
200 | 請求正常。 |
280 | 任務檢測中。 |
400 | 請求參數為空白。 |
401 | 請求參數錯誤。 |
402 | 請求參數長度不符合介面規定,請檢查並修改。 |
403 | 請求超過QPS限制,請檢查並調整並發。 |
404 | 傳入的圖片下載遇到錯誤,請檢查或重試。 |
405 | 傳入的圖片下載逾時,可能是因為圖片無法訪問,請檢查調整後重試。 |
406 | 傳入的圖片過大,請檢查調整圖片大小後再重試。 |
407 | 傳入的圖片格式暫不支援,請檢查調整後重試。 |
408 | 該帳號無許可權調用該介面,可能是帳號未開通或者已欠費,或者調用帳號未被授權訪問。 |
500 | 系統異常。 |