本文提供了調用文件檢測任務的具體內容，幫助您編寫程序構建HTTP調用請求。
使用說明
業務接口：/green/file/asyncscan，表示文件異步檢測1.0。
提交文件檢測任務，自動解析文件內容，并分別檢測其中的圖片和文本內容。
使用方法和付費價格與圖片檢測以及文本反垃圾一致。文本按照請求數收費，一次請求支持檢測5000字符；圖片按照實際圖片數收費。
使用限制
- 支持的文件類型：
- 支持檢測以下文件中的文本內容。
PDF、WORD、TXT、PPT、EXCEL、OUTLOOK、VISIO、ZIP、TAR、RTF。
- 支持檢測PDF文件中的圖片內容。
- 支持檢測以下文件中的文本內容。
- 支持的文件大?。? MB以內。
關于scene與label參數
在提交檢測任務時，您需要指定scenes場景參數；而在檢測返回結果中，則包含與您指定的場景對應的label結果分類參數。
QPS限制
本接口的單用戶QPS限制為5次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。
請求參數
說明 檢測文本需要傳入textScenes；檢測圖片需要傳入imageScenes。每個場景的使用方法和結果與圖片檢測和文本反垃圾相同。
| 名稱 | 類型 | 是否必須 | 示例值 | 描述 |
|---|---|---|---|---|
| bizType | String | 否 | default | 該字段用于標識您的業務場景。您可以通過內容安全控制臺創建業務場景（具體操作，請參見自定義機審標準）。 |
| textScenes | StringArray | 否 | ["antispam"] | 檢測內容包含文本時，指定檢測場景，取值：antispam。 說明 該參數與imageScenes不可同時為空。 |
| imageScenes | StringArray | 否 | ["porn","ad"] | 檢測內容包含圖片時，指定檢測場景，可選值包括：
說明
|
| callback | String | 否 | http://www.aliyundoc.com/xx.json | 檢測結果回調通知您的URL，支持使用HTTP和HTTPS協議的地址。該字段為空時，您必須定時輪詢檢測結果。 callback接口必須支持POST方法、UTF-8編碼的傳輸數據，以及表單參數checksum和content。內容安全按照以下規則和格式設置checksum和content，調用您的callback接口返回檢測結果。
說明 您的服務端callback接口收到內容安全推送的結果后，如果返回的HTTP狀態碼為200，則表示接收成功，其他的HTTP狀態碼均視為接收失敗。接收失敗時，內容安全將最多重復推送16次檢測結果，直到接收成功。重復推送16次后仍未接收成功，則不再推送，建議您檢查callback接口的狀態。 |
| seed | String | 否 | test | 該值用于回調通知請求中的簽名。 說明 傳入callback時，該字段必須提供。 |
| cryptType | String | 否 | SHA256 | 使用回調通知時（callback），設置對回調通知內容進行加密的算法。內容安全會將返回結果（由用戶uid + seed + content拼接的字符串）按照您設置的加密算法加密后，再發送到您的回調通知地址。取值：
|
| tasks | JSONArray | 是 | 指定檢測對象，JSON數組中的每個元素是一個檢測任務Object。最多支持100個元素，即每次提交100條內容進行檢測，支持100個元素的前提是需要將并發任務調整到100個以上。關于每個元素的具體結構描述，請見task。 |
| 名稱 | 類型 | 是否必須 | 示例值 | 描述 |
|---|---|---|---|---|
| clientInfo | JSONObject | 否 | {"userId":"28645****","userNick":"Mike","userType":"others"} | 客戶端信息，請參見公共參數中的公共查詢參數。 服務器會把全局的clientInfo和此處獨立的clientInfo合并。 說明 獨立的clientInfo優先級更高。 |
| dataId | String | 否 | test2NInmO$tAON6qYUrtCRgLo-1mwxdi | 數據ID。需要保證在一次請求中所有的ID不重復。 |
| url | String | 是 | https://www.aliyundoc.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.pdf | 檢測對象的URL。
|
content結果示例
{
"code": 200,
"msg": "OK",
"dataId": "videoId xxx",
"taskId": "taskId xxx",
"results": [
{
"label": "porn",
"rate": 99.2,
"scene": "porn",
"suggestion": "block"
}
]
}返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| code | Integer | 200 | 錯誤碼，和HTTP狀態碼一致。 更多信息，請參見公共錯誤碼。 |
| taskId | String | file_t_7Efx6ndTriK5Xx$rD2RFkr-1oB8zu | 該檢測任務的ID。 |
| dataId | String | testCvlKbUe4U@6uT6XJxh3G5-1oB8zu | 對應的請求中的dataId。 |
| msg | String | OK | 請求信息的響應消息。 |
示例
請求示例
http(s)://[Endpoint]/green/file/asyncscan
&<公共請求參數>
{
"bizType": "aligreen-test",
"textScenes": [
"antispam"
],
"imageScenes": [
"porn",
"ad"
],
"tasks": [
{
"dataId": "test2NInmO$tAON6qYUrtCRgLo-1mwxdi",
"url": "https://www.aliyundoc.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.pdf"
},
{
"dataId": "test2NInmO$tAON6qYUrtCRgLo-aksdjak",
"url": "https://www.aliyundoc.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.pdf"
}
]
}返回示例
{
"code": 200,
"data": [
{
"code": 280,
"dataId": "testCvlKbUe4U@6uT6XJxh3G5-1oB8zu",
"msg": "PROCESSING - queue",
"taskId": "file_t_7Efx6ndTriK5Xx$rD2RFkr-1oB8zu"
}
],
"msg": "OK",
"requestId": "B15C5A4F-9752-4F25-9DF8-9FF3446E72C9"
}