1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
针对业务流程中的卡证图片、场景图片等资料,提供分类、识别、比对、鉴伪等综合审核能力,可应用于商户审核、信贷审核等业务流程。一期先实现商户照片审核Agent,未来支持更多类型。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:AuditMaterialAgent。 |
| Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AgentType | 是 | String | 资料审核Agent类型,不同类型包含不同的输入、输出参数,提供不同的审核能力。 枚举值:
示例值:StorePicAudit |
| ImageUrl | 否 | String | 图片的 Url 地址。要求图片经Base64编码后不超过 10M。 示例值:url |
| ImageBase64 | 否 | String | 图片的 Base64 值。要求图片经Base64编码后不超过 10M。 示例值:base64 |
| NeedSceneType | 否 | Boolean | 商户照片分类是否输出具体场景标签。注:开启后耗时会增加。 支持该入参的资料审核Agent类型:StorePicAudit 示例值:true |
| StoreInfoHint | 否 | String | 商户名称信息,辅助判断具体场景标签。注:仅SceneType配置为true时支持。 支持该出参的资料审核Agent类型:StorePicAudit 示例值:星星便利店 |
| IgnoreWatermarkCategories.N | 否 | Array of String | 水印提示排除类型,选择出参“水印提示”排除掉的水印类型,不传的话即代表任意水印都会提示。 示例值:["PhoneCam"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| StoreLabel | Array of String | 商户照片类型 支持该出参的资料审核Agent类型:StorePicAudit 示例值:["标准门头照"] |
| SceneType | String | 商户照片分类具体场景标签,输出3个最匹配的场景, 注:仅SceneType配置为true时支持。 支持该出参的资料审核Agent类型:StorePicAudit 示例值:各类杂货店,便利店(5331)、瓶装酒零售店(5921)、各类食品店及专门食品零售店(5499) |
| StoreInfo | Array of StoreInfo | 商户门头名称 支持该出参的资料审核Agent类型:StorePicAudit |
| Angle | Float | 图片旋转角度(角度制),文本的水平方向为0°,顺时针为正,逆时针为负 支持该出参的资料审核Agent类型:StorePicAudit 示例值:4.170954704284668 |
| Tamper | SceneWarnInfo | 区域篡改提示 |
| Synthesis | SceneWarnInfo | AIGC合成提示 |
| RemakeScreen | SceneWarnInfo | 屏幕翻拍提示 |
| Screenshot | SceneWarnInfo | 截图提示 |
| TextWatermark | SceneWarnInfo | 文字水印提示 |
| WatermarkContent | String | 水印内容,当未检测到文字水印时不返回,返回多组水印时以 | 分隔。 示例值:仅限商户注册,他用无效|商户入网专用 |
| Template | SceneWarnInfo | 模板图片提示 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功示例
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AuditMaterialAgent
<公共请求参数>
{
"AgentType": "StorePicAudit",
"ImageUrl": "https://engine-private-1258344699.cos.ap-guangzhou.myqcloud.com/test/kaibin/%E7%A4%BA%E4%BE%8B%E4%BA%8C%E9%97%A8%E5%A4%B4%E7%85%A7%E6%9C%89%E6%B0%B4%E5%8D%B0.jpg?q-sign-algorithm=sha1&q-**********gT*FEwNXR4SZP0KNAhxwf8KFsEJ7e&q-sign-time=1793793983;1793801183&q-key-time=1793793983;1793801183&q-header-list=host&q-url-param-list=&q-signature=43c532b0554a5060e9ab7e9a95a7083c94455cb1",
"ImageBase64": "base64",
"NeedSceneType": true,
"StoreInfoHint": "星星便利店",
"IgnoreWatermarkCategories": [
"PhoneCam"
]
}
输出示例
{
"Response": {
"Angle": 4.170954704284668,
"RemakeScreen": {
"IsWarn": true,
"Polygon": [],
"RiskConfidence": 0.735259
},
"SceneType": "各类杂货店,便利店(5331)、瓶装酒零售店(5921)、各类食品店及专门食品零售店(5499)",
"Screenshot": {
"IsWarn": true,
"Polygon": [],
"RiskConfidence": 0.735259
},
"StoreInfo": [
{
"Name": "商店名称",
"Rect": {
"Height": 386,
"Width": 990,
"X": 307,
"Y": -30
},
"Value": "芙蓉兴盛"
}
],
"StoreLabel": [
"标准门头照"
],
"Synthesis": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.0009727084
},
"Tamper": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0
},
"Template": {
"IsWarn": false,
"Polygon": [],
"RiskConfidence": 0.415345
},
"TextWatermark": {
"IsWarn": true,
"Polygon": [],
"RiskConfidence": 0.9999729
},
"WatermarkContent": "仅限商户注册,他用无效|商户入网专用",
"RequestId": "b73c12fb-0b91-4f01-90cd-03131dc362f3"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DownLoadError | 文件下载失败。 |
| FailedOperation.ImageDecodeFailed | 图片解码失败。 |
| FailedOperation.OcrFailed | OCR识别失败。 |
| FailedOperation.UnKnowError | 未知错误。 |
| FailedOperation.UnOpenError | 服务未开通。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |