本文介紹了調用文本檢測介面(/green/text/scan)進行常值內容審核的方法。文本審核協助您檢測指定文本中是否包含色情、廣告、灌水、涉政、辱罵等違規資訊。
使用說明
業務介面:/green/text/scan,表示文本檢測。
您可以調用該介面建立常值內容檢測任務。關於如何構造HTTP請求,請參見請求結構;您也可以直接選用已構造好的HTTP請求,更多資訊,請參見SDK概覽。
說明
文本審核預設識別中文,如需識別其他語種(例如,英語、法語、德語、印尼語、馬來語、葡萄牙語、西班牙語、泰語、越南語、日語、阿拉伯語、菲律賓語、印地語、土耳其語、俄語、意大利語、荷蘭語)中的風險內容,請聯絡商務經理。
計費資訊:
該介面為收費介面。關於計費方式,請參見Alibaba Content Security Service產品定價。
QPS限制
本介面的單使用者QPS限制為100次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
bizType | String | 否 | default | |
scenes | StringArray | 是 | ["antispam"] | 指定檢測情境,取值:antispam,表示常值內容檢測。 |
tasks | JSONArray | 是 | | 指定檢測對象,JSON數組中的每個元素是一個檢測任務結構體。最多支援100個元素,即每次提交100條內容進行檢測。如果您的業務需要更大的並發量,請聯絡客戶經理申請並發擴容。關於每個元素的具體結構描述,請參見task。 |
表 1. task名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
clientInfo | JSONObject | 否 | | 用戶端資訊,請參見公用參數中的公用查詢參數。 伺服器會把全域的clientInfo和此處獨立的clientInfo合并。 |
dataId | String | 否 | cfd33235-71a4-468b-8137-a5ffe323**** | 檢測對象對應的資料ID。 由大小寫英文字母、數字、底線(_)、短劃線(-)、英文句號(.)組成,不超過128個字元,可以用於唯一標識您的業務資料。 |
content | String | 是 | 本校小額貸款,安全、快捷、方便、無抵押,隨機隨貸,當天放款,上門服務。 | 待檢測文本,最長10,000個字元(包含標點)。 |
返回資料
名稱 | 類型 | 樣本值 | 描述 |
code | Integer | 200 | 錯誤碼,和HTTP狀態代碼一致。 更多資訊,請參見公用錯誤碼。 |
msg | String | OK | 請求訊息的響應訊息。 |
dataId | String | cfd33235-71a4-468b-8137-a5ffe323**** | 檢測對象對應的資料ID。 說明 如果在檢測請求參數中傳入了dataId,則此處返回對應的dataId。 |
taskId | String | txt6HB8NQoEbU@5fosnj2xVEM-1t**** | 檢測任務的ID。 |
content | String | 本校小額貸款,安全、快捷、方便、無抵押,隨機隨貸,當天放款,上門服務。 | 被檢測文本,和調用請求中的待檢測文本對應。 |
filteredContent | String | 本校****,安全、快捷、方便、***,隨機隨貸,當天放款,****。 | 如果被檢測文本命中了自訂關鍵詞詞庫中的關鍵詞,則會返回當前欄位,並將命中的關鍵詞替換為星號(*)。 您可以通過調用建立文本庫API或者在控制台上自訂關鍵詞。更多內容,請參見建立文本庫或自訂文本庫。 |
results | JSONArray | | 返回結果。調用成功時(code=200),返回結果中包含一個或多個元素。每個元素是個結構體,具體結構描述,請參見result。 |
表 2. result名稱 | 類型 | 樣本值 | 描述 |
scene | String | antispam | 檢測情境,和調用請求中的情境對應。 |
suggestion | String | block | 建議您執行的後續操作。取值: - pass:文本正常,可以直接允許存取。
- review:文本需要進一步人工審核。
- block:文本違規,可以直接刪除或者限制公開。
|
label | String | porn | 文本垃圾檢測結果的分類。取值: - normal:正常文本
- spam:含垃圾資訊
- ad:廣告
- politics:涉政
- terrorism:暴恐
- abuse:辱罵
- porn:色情
- flood:灌水
- contraband:違禁
- meaningless:無意義
- harmful:不良情境(支援拜金炫富、追星應援、負面情緒、負面誘導等檢測情境)
- customized:自訂(例如命中自訂關鍵詞)
|
rate | Float | 99.91 | 信賴度分數,取值範圍:0(表示信賴度最低)~100(表示信賴度最高)。 如果suggestion為pass,則信賴度越高,表示內容正常的可能性越高;如果suggestion為review或block,則信賴度越高,表示內容違規的可能性越高。 重要 建議您參考suggestion和label(或者部分介面返回的sublabel)結果用於內容違規判定。 |
extras | JSONObject | {"userId":"xxx"} | 附加資訊,擴充欄位。 |
details | JSONArray | | 命中風險的詳細資料,一條文本可能命中多條風險詳情。具體結構描述,請參見detail。 |
表 3. detail名稱 | 類型 | 樣本值 | 描述 |
label | String | porn | 文本命中風險的分類。取值: - spam:含垃圾資訊
- ad:廣告
- politics:涉政
- terrorism:暴恐
- abuse:辱罵
- porn:色情
- flood:灌水
- contraband:違禁
- meaningless:無意義
- harmful:不良情境(支援拜金炫富、追星應援、負面情緒、負面誘導等檢測情境)
- customized:自訂(例如命中自訂關鍵詞)
|
contexts | JSONArray | | 命中該風險的上下文資訊。具體結構描述,請參見context。 |
表 4. context名稱 | 類型 | 樣本值 | 描述 |
context | String | 上門服務 | 檢測文本命中的風險關鍵詞,如果命中了關鍵詞會返回該內容,如果命中了演算法模型,則不會返回該欄位。 |
positions | JSONArray | [{"startPos":1, "endPos":10}] | 如果命中關鍵詞,會返回該詞在原始文本中的位置。 |
libName | String | 您自訂的詞庫名稱 | 命中自訂詞庫時,才會返回當前欄位。取值為建立詞庫時設定的詞庫名稱。 |
libCode | String | 123456 | 命中您自訂文本庫時,才會返回當前欄位。取值為建立風險文本庫後系統返回的文本庫code。 |
ruleType | String | ip | 命中行為規則時,才會返回當前欄位。取值: - user_id
- ip
- umid
- content
- similar_content
- imei
- imsi
|
樣本
請求樣本
http(s)://[Endpoint]/green/text/scan
&<公用請求參數>
{
"scenes": [
"antispam"
],
"tasks": [
{
"dataId": "cfd33235-71a4-468b-8137-a5ffe323****",
"content": "本校小額貸款,安全、快捷、方便、無抵押,隨機隨貸,當天放款,上門服務。"
}
]
}
返回結果樣本
{
"code": 200,
"data": [
{
"code": 200,
"content": "本校小額貸款,安全、快捷、方便、無抵押,隨機隨貸,當天放款,上門服務。",
"dataId": "cfd33235-71a4-468b-8137-a5ffe323****",
"filteredContent": "本校****,安全、快捷、方便、***,隨機隨貸,當天放款,****。",
"msg": "OK",
"results": [
{
"details": [
{
"contexts": [
{
"context": "無抵押",
"positions": [
{
"endPos": 19,
"startPos": 16
}
]
},
{
"context": "小額貸款",
"positions": [
{
"endPos": 6,
"startPos": 2
}
]
}
],
"label": "spam"
},
{
"contexts": [
{
"context": "上門服務",
"libCode": "123456",
"libName": "您自訂的詞庫名稱",
"positions": [
{
"endPos": 34,
"startPos": 30
}
]
}
],
"label": "porn"
}
],
"label": "porn",
"rate": 99.91,
"scene": "antispam",
"suggestion": "block"
}
],
"taskId": "txt6HB8NQoEbU@5fosnj2xVEM-1t****"
}
],
"msg": "OK",
"requestId": "25711794-BF6D-4F32-A735-09CA21197D32"
}