本文介紹了調用文本檢測接口（/green/text/scan）進行文本內容審核的方法。文本審核幫助您檢測指定文本中是否包含色情、廣告、灌水、涉政、辱罵等違規信息。
使用說明
業務接口：/green/text/scan，表示文本檢測。
您可以調用該接口創建文本內容檢測任務。關于如何構造HTTP請求，請參見請求結構；您也可以直接選用已構造好的HTTP請求，更多信息，請參見SDK概覽。
說明 文本審核默認識別中文，如需識別其他語種（例如，英語、法語、德語、印尼語、馬來語、葡萄牙語、西班牙語、泰語、越南語、日語、阿拉伯語、菲律賓語、印地語、土耳其語、俄語、意大利語、荷蘭語）中的風險內容，請聯系商務經理。
計費信息：
該接口為收費接口。關于計費方式，請參見內容安全產品定價。
QPS限制
本接口的單用戶QPS限制為100次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。
請求參數
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
| bizType | String | 否 | default | |
| scenes | StringArray | 是 | ["antispam"] | 指定檢測場景，取值：antispam，表示文本內容檢測。 |
| tasks | JSONArray | 是 | 指定檢測對象，JSON數組中的每個元素是一個檢測任務結構體。最多支持100個元素，即每次提交100條內容進行檢測。如果您的業務需要更大的并發量，請聯系客戶經理申請并發擴容。關于每個元素的具體結構描述，請參見task。 |
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
| clientInfo | JSONObject | 否 | 客戶端信息，請參見公共參數中的公共查詢參數。 服務器會把全局的clientInfo和此處獨立的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 | 本校****，安全、快捷、方便、***，隨機隨貸，當天放款，****。 | 如果被檢測文本命中了自定義關鍵詞詞庫中的關鍵詞，則會返回當前字段，并將命中的關鍵詞替換為星號（*）。 |
| results | JSONArray | 返回結果。調用成功時（code=200），返回結果中包含一個或多個元素。每個元素是個結構體，具體結構描述，請參見result。 |
| 名稱 | 類型 | 示例值 | 描述 |
| scene | String | antispam | 檢測場景，和調用請求中的場景對應。 |
| suggestion | String | block | 建議您執行的后續操作。取值：
|
| label | String | porn | 文本垃圾檢測結果的分類。取值：
|
| rate | Float | 99.91 | 置信度分數，取值范圍：0（表示置信度最低）~100（表示置信度最高）。 如果suggestion為pass，則置信度越高，表示內容正常的可能性越高；如果suggestion為review或block，則置信度越高，表示內容違規的可能性越高。 重要 建議您參考suggestion和label（或者部分接口返回的sublabel）結果用于內容違規判定。 |
| extras | JSONObject | {"userId":"xxx"} | 附加信息，擴展字段。 |
| details | JSONArray | 命中風險的詳細信息，一條文本可能命中多條風險詳情。具體結構描述，請參見detail。 |
| 名稱 | 類型 | 示例值 | 描述 |
| label | String | porn | 文本命中風險的分類。取值：
|
| contexts | JSONArray | 命中該風險的上下文信息。具體結構描述，請參見context。 |
| 名稱 | 類型 | 示例值 | 描述 |
| context | String | 上門服務 | 檢測文本命中的風險關鍵詞，如果命中了關鍵詞會返回該內容，如果命中了算法模型，則不會返回該字段。 |
| positions | JSONArray | [{"startPos":1, "endPos":10}] | 如果命中關鍵詞，會返回該詞在原始文本中的位置。 |
| libName | String | 您自定義的詞庫名稱 | 命中自定義詞庫時，才會返回當前字段。取值為創建詞庫時設置的詞庫名稱。 |
| libCode | String | 123456 | 命中您自定義文本庫時，才會返回當前字段。取值為創建風險文本庫后系統返回的文本庫code。 |
| ruleType | String | ip | 命中行為規則時，才會返回當前字段。取值：
|
示例
請求示例
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"
}文檔內容是否對您有幫助？