文本识别

最近更新时间:2020-07-30 11:57:33

内容安全文本识别API文档

目录

调用方式

请求结构

服务地址

内容安全文本识别API的服务接入地址为:http://itr.api.ksyun.com

通信协议

支持通过HTTP或HTTPS协议进行请求通信。为保证您的服务安全性,请使用HTTPS协议进行通信。

请求方式

支持GET方法发送请求,注意参数需要进行urlencode。

公共参数

公共请求header

参数名 必选 类型 说明
Authorization string 必要的请求验证信息
X-Amz-Date string 当前请求的时间戳,例如:20181026T114852Z
Host string itr.api.ksyun.com

签名参数

Region:金山云机房信息,目前仅支持cn-beijing-6

Service:固定为itr

返回结果

接口统一返回json格式数据,满足以下格式:

{
    "header":{
      "err_no":200,
      "err_msg":"success"
    },
    "cost":0.11,
    "request_id": "d679e27b-9f1b-44bf-b134-49a6d9f0adff",
    "request_time": 1234567890123,
    "body":{}
}

调用成功,err_no返回200,msg为success,否则返回对应错误码及错误信息。

cost为服务端耗时,单位秒。

每此请求会返回唯一的请求表示request_id,调用失败时提供request_id给金山云客服,方便定位问题。

request_time为每次请求时的服务器时间

签名机制

详见金山云签名机制文档

文本过滤接口

输入:

GET参数部分

参数名 必选 类型 说明
Action=ClassifyText string 固定此值
Version=2018-10-26 string API版本号,固定此值

POST请求示例

{
    "text":"社会主义好,毛主席万岁,以人为本,邓小平理论",
    "guard_id":"1553754923733682476"

}

POST参数说明

参数 必选 类型 说明
text string 需要识别的文本内容
guard_id string 送审id

送审计划id获取路径:金睛内容识别 > 送审管理模块 > 送审计划列表/送审计划详情 > 复制送审计划id

文本识别

详见金睛内容识别平台操作手册

接口返回:

{
    "cost": 0.25,
    "header": {
        "err_no": 200,
        "err_msg": "success"
    },
    "request_id": "b59c67bf196a4876465e42f76670ceba",
    "request_time": 1554166003593,
    "body": {
        "suggest_summary": "suggest_review",
        "suggest_summary_code": "216000",
        "suggest_summary_message": "文本违规",
        "results": [
            {
                "business": "tfs",
                "label": "5",
                "rate": 0.95455,
                "label_desc": "涉政",
                "match_item": [
                    {
                        "word": "毛主席"
                    },
                    {
                        "word": "邓小平"
                    }
                ]
            }
        ]
    }
}

文本正常时接口返回:

{
    "cost": 0.199,
    "header": {
        "err_no": 200,
        "err_msg": "success"
    },
    "request_id": "b59c67bf196a4876465e42f76670ceba",
    "request_time": 1554166590982,
    "body": {
        "suggest_summary": "normal",
        "suggest_summary_code": "100000",
        "suggest_summary_message": "正常",
        "results": [
            {
                "business": "tfs",
                "label": "1",
                "rate": 1.0,
                "label_desc": "正常",
                "match_item":[]
            }
        ]
    }
}

接口输出字段解释:

字段 类型 是否必须 说明
cost float 接口耗时
suggest_summary string 摘要:normal,suggest_review ,confirm_reject
suggest_summary_code string 摘要码:100000、216000
suggest_summary_message string 摘要信息:正常、文本违规
business string 业务类型
tfs文本过滤
score double 置信度
label string 分类标签ID(int类型)
tfs: 1正常,2涉黄,3广告,4涉暴,5涉政,6辱骂,7灌水,8其它违规,9正常-自定义文本白名单,10文本违规-自定义文本黑名单
label_desc string 分类标签(string类型)
tfs: 1正常,2涉黄,3广告,4涉暴,5涉政,6辱骂,7灌水,8其它违规,9正常-自定义文本白名单,10文本违规-自定义文本黑名单
match_item array 命中敏感词
当文本不包含违规词,通过上下文语意推理得出违规的识别结果时,该字段为空

错误码

err_no err_msg 说明
421 未开通文本过滤服务 未开通文本过滤服务
500 Service Internal Error 内部错误
400 传入的参数不对 传入的参数不对
509 模型处理异常! 模型处理异常!
510 请求太频繁 请求QPS超过限制
1003 文本长度过长! 文本长度过长!最大支持6000词

金山云,开启您的云计算之旅

免费注册