本文介紹了調用文本審核增強版接口審核文本內容的方法。
使用說明
您可以調用該接口創建文本內容檢測任務。關于如何構造HTTP請求,請參見HTTPS原生調用;您也可以直接選用已構造好的HTTP請求,更多信息,請參見接入指南的文本審核增強版通用服務部分。
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
業務接口:TextModeration
支持的地域及接入地址:
地域
外網接入地址
內網接入地址
華東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
暫無
計費信息:
該接口為收費接口。僅對HTTP狀態碼為200的請求進行計量計費,產生其他錯誤碼時不會計費。關于計費方式,請參見計費說明。
QPS限制
本接口的單用戶QPS限制為100次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。
請求參數
名稱 | 類型 | 是否必須 | 示例值 | 描述 |
Service | String | 是 | nickname_detection | 審核服務類型,包括:
|
ServiceParameters | JSONString | 是 | 審核服務需要的參數集。JSON字符串格式,關于每個字符串的描述,請參見ServiceParameters。 |
表 1. ServiceParameters
名稱 | 類型 | 是否必須 | 示例值 | 描述 |
content | String | 是 | 檢測內容 | 審核的文本內容,限定在600字符以內。 |
accountId | String | 否 | 10123**** | 賬戶ID,標識一個賬戶的唯一ID。 |
deviceId | String | 否 | 20240307**** | 設備ID,標識一個設備的唯一ID。 |
deviceToken | String | 否 | MzQvo1d7scyZ3tl_RcJ****** | 通過風險控制SDK獲取到的設備令牌。 |
返回參數
名稱 | 類型 | 示例值 | 描述 |
Code | Integer | 200 | 狀態碼。更多信息,請參見Code說明。 |
Data | JSONObject | 審核結果數據。更多信息,請參見Data。 | |
Message | String | OK | 請求消息的響應消息。 |
RequestId | String | AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE**** | 請求ID。 |
表 2. Data
名稱 | 類型 | 示例值 | 描述 |
Labels | String | sexual_content | 標簽,多個用英文逗號分隔。包括:
說明 標簽會持續新增,建議業務對接過程對未知標簽忽略處理。 |
Reason | String | {\"riskLevel\":\"high\",\"riskTips\":\"色情_低俗詞\",\"riskWords\":\"色情服務\"} | 原因定位的JSON字符串,包含以下字段:
|
AccountId | String | 10123**** | 賬戶ID。 說明 如果在檢測請求參數中傳入了accountId,則此處返回對應的accountId。 |
DeviceId | String | 20240307**** | 設備ID。 說明 如果在檢測請求參數中傳入了deviceId,則此處返回對應的deviceId。 |
示例
請求示例
{
"Service": "nickname_detection",
"ServiceParameters": {
"content": "檢測內容",
"accountId": "10123****"
}
}
返回示例:
命中系統策略:
{
"Code": 200,
"Data": {
"Labels": "sexual_content",
"Reason": "{\"riskLevel\":\"high\",\"riskTips\":\"色情_低俗詞\",\"riskWords\":\"色情服務\"}",
"AccountId": "10123****"
},
"Message": "OK",
"RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****"
}
命中自定義關鍵詞:
{
"Code": 200,
"Data": {
"Labels": "sexual_content",
"Reason": "{\"riskLevel\":\"high\",\"customizedWords\":\"自定義關鍵詞\",\"customizedLibs\":\"自定義關鍵詞庫名稱\"}",
"AccountId": "10123****"
},
"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 | 請求頻率超出配額。 |