1. 接口描述
接口请求域名: mrs.tencentcloudapi.com 。
图片分类
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ImageToClass。 |
Version | 是 | String | 公共参数,本接口取值:2020-09-10。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ImageInfoList.N | 是 | Array of ImageInfo | 图片列表,允许传入多张图片,支持传入图片的base64编码,暂不支持图片url |
HandleParam | 是 | HandleParam | 图片处理参数 |
Type | 是 | Integer | 不填,默认为0 示例值:0 |
UserType | 否 | Integer | 后付费的用户类型,新客户传1,老客户可不传或传 0。2022 年 12 月 15 新增了计费项,在此时间之前已经通过商务指定优惠价格的大客户,请不传这个字段或传 0,如果传 1 会导致以前获得的折扣价格失效。在 2022 年 12 月 15 日之后,通过商务指定优惠价格的大客户请传 1。 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TextTypeList | Array of TextType | 分类结果 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 图片分类
输入一张图片,得到报告分类信息
输入示例
POST / HTTP/1.1
Host: mrs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImageToClass
<公共请求参数>
{
"Type": 0,
"UserType": 0,
"HandleParam": {
"OcrEngineType": 2,
"IsScale": false,
"ImageOriginalSize": 310006,
"AutoFitDirection": false,
"IsReturnText": false,
"ScaleTargetSize": 300000,
"AutoOptimizeCoordinate": true,
"RotateTheAngle": 0.0
},
"ImageInfoList": [
{
"Url": "https://medres-1254237151.cos.ap-shanghai.myqcloud.com/upload/tNurJ6BitYm6bUk1DnVZw7dF.jpg",
"Base64": "",
"Id": 1
}
]
}
输出示例
{
"Response": {
"RequestId": "cc99532b-3865-4295-a2dd-823749a1d035",
"TextTypeList": [
{
"Id": 12,
"Level": 1,
"Name": "检查报告"
},
{
"Id": 345,
"Level": 2,
"Name": "超声检查"
},
{
"Id": 345,
"Level": 3,
"Name": "超声检查"
}
]
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation.PushUsageMessageError | 用量消息推送失败。 |
FailedOperation.ServiceNotOpen | 服务未开通。 |
FailedOperation.UnknownError | 未知错误。 |
InternalError | 内部错误。 |
InternalError.ImageOcrError | 图片ocr识别异常。 |
InternalError.ImageProcessError | 图片处理异常。 |
InternalError.ServerTimeOutError | 服务调用超时。 |
InternalError.StructionError | 报告结构化异常。 |
InternalError.TextClassifyError | 报告文本分类异常。 |
InvalidParameter | 参数错误。 |
InvalidParameter.AutoFitDirection | 参数AutoFitDirection无效。 |
InvalidParameter.ImageInfoList | 参数ImageInfoList无效。 |
InvalidParameter.ImageOriginalSize | 参数ImageOriginalSize无效。 |
InvalidParameter.InvalidAction | 请求Action无效。 |
InvalidParameter.OcrEngineType | 参数OcrEngineType无效。 |
InvalidParameter.RotateTheAngle | 参数RotateTheAngle无效。 |
InvalidParameter.Text | 参数Text无效。 |
InvalidParameterValue.ImageCodeInvalid | 图片编码无效。 |
InvalidParameterValue.ImageURLInvalid | 图片URL无效。 |
OperationDenied.UnSupportThisType | 不支持的报告类型。 |
UnauthorizedOperation.PermissionDeniedError | 当前无权限,请检查BisinsessId。 |
UnsupportedOperation.UnSupportThisType | 当前报告类型不支持。 |