文本涉政審核
更新時間 2024-10-25 15:14:48
最近更新時間: 2024-10-25 15:14:48
分享文章
1、接口描述
用于自動審核指定文本中是否存在涉政敏感內容，并給出該文本的涉政指數，表明文本內容的涉政程度。
2、請求方法
POST
3、接口要求
- 單條文字數量不超過9999字符，批量請求單次不超過50篇
- 僅支持中文文本，文本內容超過50%非中文，返回評分0.5
4、URI
/v1/aiop/api/2f3rrma38pvk/FileIdentity2/api/v1/text_politic.json
5、請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | json格式 | application/json | |
| appkey | 是 | String | 平臺應用appkey | 562b89493b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用戶請求 id，由用戶構造，用戶可以通過 uuid 等方法自行生成唯一字符串，用于日志請求追蹤。 詳見文檔：Python3調用示例 |
33dfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 請求時間，由用戶構造，形如 yyyymmddTHHMMSSZ。 詳見文檔：Python3調用示例 |
20211221T163014Z | |
| host | 是 | String | 終端節點域名，固定字段 | ai-global.ctapi.daliqc.cn | |
| Eop-Authorization | 是 | String | 由天翼云官網 accessKey 和 securityKey 經簽名后生成，參與簽名生成的字段包括天翼云官網 accessKey 、securityKey、平臺應用的appkey（非必須），用戶請求id（非必須），請求時間，終端節點域名（非必須）以及請求體內容。 簽名邏輯詳見文檔：認證鑒權和Python3調用示例 |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| data | 是 | List | 待處理文本列表 | ["測試文本1", "測試文本2"] | / |
6、請求代碼示例
Curl -X POST
"//ai-global.ctapi.daliqc.cn/ctcloud/v1/aiop/api/2f3rrma38pvk/FileIdentity2/api/v1/text_politic.json"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "appkey:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:ai-global.ctapi.daliqc.cn"
--data '{"data":["AAAAAAAAA...."]}'
7、返回值說明
請求成功返回響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | Int | 返回狀態，返回 0 表示成功，返回錯誤代碼參考下面的錯誤代碼列表。 | 0 | |
| message | 是 | String | 如果statusCode 為 0，返回 success；如果statusCode 非 0，則返回對應的可讀錯誤信息。 | success | |
| returnObj | 是 | Dict | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| politic | 是 | List | 審核場景 | / | politic[] |
表politic
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| label | 是 | Int | 分類標簽值 | 0 | / |
| class_name | 是 | String | 分類標簽描述 | 違規 | / |
| confidence | 是 | Float | 該段文本違規的置信度 | 0.98 | / |
請求失敗返回響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| code | 是 | Int | 錯誤碼，放置API對應的錯誤碼 | 4010 | |
| message | 是 | Str | 返回對應的錯誤信息 | error | |
| details | 是 | Str | 返回對應的錯誤描述 | 文件大小不符合要求 | |
| error | 是 | String | 返回對應的錯誤碼 | AI_OP_4101 |
8、返回值示例
請求成功返回值示例
{
"statusCode": 0,
"message": {"success":3, "fail":0},
"returnObj":{
"politic": [
{
"label": 0,
"class_name": "正常",
"confidence": 0.315978
},
{
"label": 0,
"class_name": "正常",
"confidence": 0.0000078003
},
{
"label": 1,
"class_name": "違規",
"confidence": 0.985978
}
]
}
}
請求失敗返回值示例
{
"statusCode": 4010,
"message": "error",
"details": "文件大小不符合要求"
"error":"AI_OP_4010"
}
9、狀態碼
| http狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
10、錯誤碼說明
4位錯誤碼。4開頭為業務錯誤碼，5開頭為服務錯誤碼。
| 錯誤碼 | 錯誤信息 | 錯誤描述 |
|---|---|---|
| AI_OP_4010 | 文件大小不符合要求 | 文本字符超過了9999字 |
| AI_OP_4017 | 處理該請求超時 | 該請求內部處理超時，請稍后再試。 |
| AI_OP_4018 | 單次批量請求數量超過限制 | 該批次請求量超過限制，請降低單批次請求量 |
| AI_OP_5000 | 服務內部錯誤 | 需要聯系管理員處理 |
| AI_OP_5001 | 服務接口異常，請聯系管理員 | 當前接口無法正常處理請求，需要聯系管理員處理。 |
| AI_OP_5003 | 場景接口異常，具體參見返回消息 | 后端服務超時等 |
