1、接口描述
分析并識別上傳的文本內容是否有敏感內容,并將識別結果返回給您。
2、請求方法
POST
3、接口要求
只支持中文文本內容審核。
4、請求URL
廣州資源池://moderation.cn-gdgz1.daliqc.cn/v3/{project_id}/moderation/text
蘇州資源池://content-security-analysis.cn-jssz1.daliqc.cn/v3/{project_id}/moderation/text
5、請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | json 格式 | application/json | |
| X-Auth-Token | 是 | String | 用戶Token。用于獲取操作API的權限。請參考獲取token示例。 | ||
| project_id | 是 | String | 項目ID。進入內容審核(經典版)管理控制臺,在控制中心頁面,鼠標移動至到右上角的用戶名上,在下拉列表中單擊“我的憑證”,在“我的憑證”頁面的項目列表中,可以查看對應區域的項目ID |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| event_type | 是 | String | 事件類型。可選值有:nickname: 昵稱、title: 標題、article: 帖子、comment: 評論、barrage: 彈幕、search: 搜索欄、profile: 個人簡介 | ||
| glossary_names | 否 | Array of strings | 檢測時使用的自定義黑名單詞庫列表。 說明:自定義黑名單詞庫的創建和使用請參見配置自定義詞庫 V3。 |
||
| white_glossary_names | 否 | Array of strings | 檢測時使用的自定義白名單詞庫列表。 說明:自定義白名單詞庫的創建和使用請參見配置自定義詞庫V3。 |
||
| data | 是 | Object | 檢測數據 | data |
表data
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| text | 是 | String | 待檢測文本,編碼格式為“utf-8”,限定1500個字符以內,文本長度超過1500個字符時,只檢測前1500個字符 |
6、請求代碼示例
curl --location --globoff '//moderation.cn-gdgz1.daliqc.cn/v3/{project_id}/moderation/text' \
--header 'X-Auth-Token: XXXXXX' \
--header 'Content-Type: application/json;charset=utf8' \
--data '{
"event_type": "comment",
"data": {
"text": "測試文本"
}
}'
7、返回值說明
請求成功返回響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| request_id | 是 | String | 本次請求的唯一標識,用于問題排查,建議保存。最小長度2,最大長度64 | ||
| result | 是 | Object | 返回內容審核調用結果 | success | result |
表result
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| suggestion | 是 | String | 審核結果是否通過。有三種結果:block:包含敏感信息,不通過、pass:不包含敏感信息,通過、review:需要人工復檢 | block | |
| label | 是 | String | 檢測結果的標簽。支持label列表有:terrorism: 暴恐、porn: 色情、ban: 違禁、abuse: 辱罵、ad: 廣告、ad_law: 廣告法 | ||
| details | 是 | Array of objects | 檢測詳情 | details |
表details
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| suggestion | 是 | String | 審核結果是否通過。有三種結果:block:包含敏感信息,不通過、pass:不包含敏感信息,通過、review:需要人工復檢 | block | |
| label | 是 | String | 檢測結果的標簽。支持label列表有:terrorism: 暴恐、porn: 色情、ban: 違禁、abuse: 辱罵、ad: 廣告、ad_law: 廣告法 | ||
| confidence | 是 | Float | 置信度,取值范圍 0-1,值越大,可信度越高 | ||
| segments | 是 | Array of objects | 命中的風險片段信息,如果命中了語義算法模型,則會返回一個空的列表 | segment |
表segments
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| segment | 是 | String | 命中的風險片段 | ||
| glossary_name | 否 | String | 命中的自定義詞庫名稱。 命中自定義詞庫時,才會返回當前字段。 |
||
| position | 否 | Array of integers | 命中的風險片段在文本中的位置,起始位置從0開始。 |
請求失敗返回響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| error_code | 是 | String | 調用失敗時的錯誤碼 | ||
| error_msg | 是 | String | 調用失敗時的錯誤信息 |
8、返回值示例
請求成功返回值示例
{
"request_id": "58e7d9c7-3456-4ba1-80df-6f25506bc4df",
"result":: {
"suggestion" : "block",
"label" : "porn",
"details" : [ {
"suggestion" : "block",
"label" : "porn",
"confidence" : 1,
"segments" : [ {
"segment" : "xxx",
} ]
} ]
}
}
請求失敗返回值示例
{
"error_code" : "AIS.0011",
"error_msg" : "Lack the request parameter, or the request parameter is empty."
}
獲取token示例
獲取用戶的AK和SK,作用范圍為項目"cn-jssz1",通過用戶名、賬號名、密碼方式獲取Token,用戶名、賬號名查詢路徑:進入內容審核(經典版)管理控制臺,在控制中心頁面,鼠標移動至到右上角的用戶名上,在下拉列表中單擊“我的憑證”即可查詢到。
廣州4項目名稱:cn-gdgz1
蘇州項目名稱:cn-jssz1
POST //iam.cn-jssz1.daliqc.cn/v3/auth/tokens (所有局點均使用此URL地址)
{
"auth": {
"identity": {
"password": {
"user": {
"name": "IAMUser", //IAM用戶名
"password": "IAMPassword", //IAM用戶密碼
"domain": {
"name": "IAMDomain" //IAM用戶所屬賬號名
}
}
},
"methods": [
"password"
]
},
"scope": {
"project": {
"name": "cn-jssz1" //根據局點選取相應項目名稱
}
}
}
}
狀態碼為201時:請求成功。
響應Header參數(獲取到的Token):
X-Subject-Token:MIIatAYJKoZIhvcNAQcCoIIapTCCGqECAQExDTALB...
9、狀態碼
| http狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功 |
| 400 | 表示請求失敗 |
10、錯誤碼說明
| 錯誤碼 | 錯誤信息 | 錯誤描述 |
|---|---|---|
| AIS.0004 | The request is unauthorized. | 服務未開通請開通服務。 |
| AIS.0014 | The JSON format of the input data is incorrect. | 請檢查輸入數據的JSON格式。 |
| AIS.0401 | The input parameter is incorrect. | 請輸入正確的參數。 |
| AIS.0011 | Lack the request parameter, or the request parameter is empty. | 請檢查請求body是否缺少必須字段,請參考對應API的請求說明。 |
| AIS.0413 | The request reach rate limit. | 請求觸發流控。 |
11、配置自定義詞庫V3
在使用文本審核/圖像審核時,支持用戶配置自定義白名單詞庫和自定義黑名單詞庫,來幫助客戶過濾和檢測指定文本內容。
說明:配置自定義詞庫后,需要用戶自行維護。
背景信息
- 配置自定義詞庫需要先開通文本內容審核服務。
- 配置后可以使用自定義詞庫。
- 一個賬戶最多支持創建10個自定義詞庫。
創建自定義詞庫
說明:白名單詞庫的處理建議選擇“通過”,黑名單詞庫的處理建議選擇“違規”或“疑似”。
-
登錄內容審核(經典版)服務管理控制臺。
-
在左側菜單欄中選擇“設置>自定義詞庫“,在“自定義詞庫 V3”頁面單擊“創建詞庫“按鈕,會彈出“創建詞庫“窗口。
-
在窗口中填寫參數后單擊“確定“,完成詞庫的創建。
- 名稱:長度小于50個字符,只能包含字母、數字、中劃線和下劃線。
- 處理建議:有“通過、違規、疑似”三種選則,選擇“通過”則為白名單詞庫,選擇“違規、疑似”則為黑名單詞庫。
- 使用場景:選擇需要的使用場景,目前包括(涉政、暴恐、色情、違禁、辱罵、廣告、自定義、正常)。
- 匹配方式:原文匹配。
- 描述:對此詞庫的描述。
說明:詞庫名稱不支持修改。
-
創建好后,在列表頁面單擊操作列的“管理”,即可增加關鍵詞。
修改或刪除自定義詞庫
- 登錄內容審核(經典版)服務管理控制臺。
- 在左側菜單欄中選擇“設置>自定義詞庫“,在“自定義詞庫 V3”頁面。
- 單擊目標詞庫操作列的“管理“,修改目標關鍵詞內容,單擊“確定“完成修改。
- 單擊目標詞庫操作列的“刪除“,刪除目標關鍵詞內容,單擊“確定“完成刪除。
說明:刪除操作不可恢復,請謹慎操作。