图像识别
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 图像识别 > API 文档 > 图像识别相关接口 > 文件封识别

文件封识别

最近更新时间：2024-03-12 01:55:35

我的收藏

本页目录：

1. 接口描述

接口请求域名： tiia.tencentcloudapi.com 。

文件封识别可检测图片中是否包含符合文件封（即文件、单据、资料等的袋状包装）特征的物品，覆盖顺丰快递文件封、文件袋、档案袋等多种文件封类型，可应用于物流行业对文件快递的包装审核等场景。

说明：

  • 公共参数中的签名方式必须指定为V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DetectEnvelope。
Version 是 String 公共参数，本接口取值：2019-05-29。
Region 是 String 公共参数，详见产品支持的 地域列表。
ImageUrl 否 String 图片的URL地址。图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
图片大小的限制为4M，图片像素的限制为4k。
示例值：https://test.jpg
ImageBase64 否 String 图片经过base64编码的内容。与ImageUrl同时存在时优先使用ImageUrl字段。
图片大小的限制为4M，图片像素的限制为4k。
**注意：图片需要base64编码，并且要去掉编码头部。
示例值：1234

3. 输出参数

参数名称 类型 描述
FirstTags Array of ImageTag 一级标签结果数组。识别是否文件封。
注意：此字段可能返回 null，表示取不到有效值。
SecondTags Array of ImageTag 二级标签结果数组。识别文件封正反面。
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用失败示例

输入示例

POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectEnvelope
<公共请求参数>

{
    "ImageUrl": "https://test.jpg"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.DownloadError ",
            "Message": "文件下载错误。"
        },
        "RequestId": "ad418ac5-fbfd-4bd7-8f4a-35ab085e27dd"
    }
}

示例2 调用成功示例

输入示例

POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectEnvelope
<公共请求参数>

{
    "ImageUrl": "http://test.jpg"
}

输出示例

{
    "Response": {
        "FirstTags": [
            {
                "Name": "非文件封",
                "Confidence": 97.76
            },
            {
                "Name": "文件封",
                "Confidence": 2.24
            }
        ],
        "SecondTags": [
            {
                "Name": "非文件封",
                "Confidence": 97.5
            },
            {
                "Name": "非顺丰文件封正面",
                "Confidence": 2.28
            },
            {
                "Name": "顺丰文件封正面",
                "Confidence": 0.09
            },
            {
                "Name": "非顺丰文件封反面",
                "Confidence": 0.07
            },
            {
                "Name": "顺丰文件封反面",
                "Confidence": 0.05
            }
        ],
        "RequestId": "c7552894-0e1c-468d-afc7-685483c3e3be"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.DownloadError 文件下载错误。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageNotSupported 不支持的图片文件。
FailedOperation.ImageSizeExceed base64编码后的图片数据过大。
FailedOperation.ImageUrlInvalid url地址不合法，无法下载。
FailedOperation.InnerError 内部错误。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.RpcFail RPC请求失败，一般为算法微服务故障。
FailedOperation.TooLargeFileError 文件太大。
InvalidParameter.InvalidParameter 参数取值错误。
InvalidParameterValue.UrlIllegal URL格式不合法。
LimitExceeded.TooLargeFileError 文件太大。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.NotExist 计费状态未知，请确认是否已在控制台开通服务。
中国站