文字识别通用文字识别Agent

1. 接口描述

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

支持对输入图的内容进行判断、分类以及总结；支持用户对通用文字识别输出结构进行自定义。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：RecognizeAgent。
Version	是	String	公共参数，本接口取值：2018-11-19。
Region	否	String	公共参数，此参数为可选参数。
ImageUrl	否	String	图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。示例值：https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/general/GeneralAccurateOCR/GeneralAccurateOCR1.jpg
ImageBase64	否	String	图片/PDF的 Base64 值。要求图片经Base64编码后不超过 10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。示例值：/9j/4AAQSkZJRg.....s97n//2Q==
PdfPageNumber	否	Integer	需识别的PDF页码。仅支持PDF单页识别，当上传文件为PDF时有效。默认值：1 示例值：1
SelectModel	否	Integer	模型选择。枚举值： 0：推理模型。 1：识别、推理模型。默认值：0 示例值：0
QueryType	否	Integer	任务类型。枚举值： 0：全文识别。识别且输出全文内容。 1：判断。判断输入图的内容是否为Query中的内容，返回结果为是或否。如Query:"增值税发票"，该任务类型下，将判断输入图是否为增值税发票，返回"是"或"否"。 2：分类。判断输入图属于Query中具体哪个分类项。如Query:["营业执照","合同","票据"]，在该任务类型下，将判断输入图是否属于"营业执照"、"合同"、"票据"，返回"营业执照"/"合同"/"票据"或"均不符合"。 3：总结提炼。总结输入图与Query相关的内容。如Query:"工作经历"，在该任务类型下，将输出输入图中和"工作经历"相关的内容，或"无相关内容"。 4：信息提取。按照自定义字段提取Key-Value，且支持多层级提取，详见入参SchemaItems说明。入参可参考下面的接口示例QueryType=4场景默认值：0 示例值：0
SchemaItems.N	否	Array of SchemaList	自定义提取字段的结构，详见SchemaList结构。仅当QueryType=4时生效。注：.N表示数组型参数。
Query.N	否	Array of String	推理任务的提示词。与QueryType搭配使用，具体说明见QueryType描述。1）仅当QueryType=1/2/3时生效，且QueryType=1/3时，长度必须为1；2）QueryType=2，Query长度必须符合2≤x≤5。注：.N表示数组型参数。示例值：["增值税专用发票"]
EnableCoord	否	Boolean	是否需要返回坐标。默认值：false 注：仅对QueryType=4时生效，且坐标位置为 Response.ExtractFields.Polygon。示例值：false

3. 输出参数

参数名称	类型	描述
Response	Array of ListInfo	返回内容。详见ListInfo。
Angle	Float	图片旋转角度(角度制)，文本的水平方向为 0；顺时针为正，逆时针为负。示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 QueryType=0全文识别

识别且输出全文内容

输入示例

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

{
    "QueryType": 0,
    "ImageUrl": "https://demo-1400073141.cos.ap-guan***o*.myqcloud.com/10.%20image2.jpg*q-sign-a**orithm=sha1&q-ak=AKID**vZ0eN6*j2NsBQJn7TdtNs1K0*l*Jn8i**E*aEKREeZimpybAs***bVG1Aoot*n&q-sign-time=177*824**1;1776*28351&q-key-time=17**824751**776828351&q-header-l*s******&q-url-param-list=&q-signature=83bb8ce9c768fde565e71b0460e6dbde1b4886f4&x-cos-security-token=xheG1dXFML3tXG5BbL3WBkxVgTMPn53a305890e6c04febe60e215a5a32833a69POGPBv-E8gHNUZW60alPmkc4RfdRY-_t8Ui8YDNXe1cYF6_ToPvP6_zzdNrdcV7IFK2puDFJESTWb5bpdgNFzBYaIqMBzQ5mGNamTbS3zRP0FMQTNpGj-3aq5Y0Nq46WuYcs4KcX29RE6LuZeuUo9ODhoWjqS69N4MmunTB2fJwpu9GqgkKpLu98DaKKIFpxF_12tfVf4_RuH1xbATmJAMl4h1-ni7Ga25th3WlWlDgJ1WE15lVSJueMoPdmbNvvOQBuBl4zTGtc3AEy3MFKmg",
    "SelectModel": 0
}

输出示例

{
    "Response": {
        "Angle": 0,
        "RequestId": "4cfcc12b-4626-4c59-b586-69c5420a038b",
        "Response": [
            {
                "Answer": "",
                "QueryInfo": "",
                "TextDetections": [
                    {
                        "AdvancedInfo": "{\"Parag\":{\"ParagNo\":1}}",
                        "Confidence": 99,
                        "DetectedText": "学",
                        "ItemPolygon": {
                            "Height": 48,
                            "Width": 43,
                            "X": 563,
                            "Y": 41
                        },
                        "Polygon": [
                            {
                                "X": 563,
                                "Y": 44
                            },
                            {
                                "X": 602,
                                "Y": 41
                            },
                            {
                                "X": 606,
                                "Y": 85
                            },
                            {
                                "X": 567,
                                "Y": 89
                            }
                        ],
                        "WordCoordPoint": [],
                        "Words": []
                    },
                    {
                        "AdvancedInfo": "{\"Parag\":{\"ParagNo\":97}}",
                        "Confidence": 99,
                        "DetectedText": "获取证书",
                        "ItemPolygon": {
                            "Height": 179,
                            "Width": 44,
                            "X": 184,
                            "Y": 1334
                        },
                        "Polygon": [
                            {
                                "X": 190,
                                "Y": 1334
                            },
                            {
                                "X": 228,
                                "Y": 1335
                            },
                            {
                                "X": 222,
                                "Y": 1513
                            },
                            {
                                "X": 184,
                                "Y": 1511
                            }
                        ],
                        "WordCoordPoint": [],
                        "Words": []
                    }
                ]
            }
        ]
    }
}

示例2 QueryType=1判断

判断输入图是否为{增值税发票}

输入示例

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

{
    "Query": [
        "增值税专用发票"
    ],
    "QueryType": 1,
    "ImageUrl": "https://demo-1400073141.cos.ap-guangzhou.myqcloud.com/10.%20image2.j**?***ign-algorithm=sha1&q***=AKIDK8Gu4gzUbrOpn8kb39mD*i594DkHgNJrrT20ogVq5WW0-hTRR*MP***S*Yn*_*Y*&q-sign-time=1**6*50064;17767**664&q-key-tim*=1*7**5*0****77*753664&q-head**-list=host&q*url-param-list=&*-*ignatur**2936fe3e8fb70d0883100e*2*e9e829b83e6cd79&x-cos-security-token=2h4y82Xge6IaO54EmvE4bkv7jnUKzcHa60478ede97391b5c9812986943e6b2b4VQOPSF0rD_E_hBrKn29TH08ObJC1ujL1EVTKrbVHKYxip6a1Sm9GrhNz9KuYTG4V9BJ_RptFea1UUlABknv0GNlp-0tr23g2t7-WMtZTxfS0kCDsQoXiq-t1Egh5uXxoLzqM8XWJv6KG4jSi3mG4jGkDoefVlbh680uYMGkmSTHDMTUDQ-1kpsJcPr2N7JmBQ1Dr2VrMbFnvLz2GE5hQHQjuo54MUZoXSA_evrJXegbWREY01E_sLHNMv9E-SG_UzSPMuX9wnJPJioo7CAg6vg",
    "SelectModel": 0
}

输出示例

{
    "Response": {
        "Angle": 0,
        "Response": [
            {
                "Answer": "否",
                "QueryInfo": "根据图片内容，判断这张图是不是增值税专用发票？只回答 是 / 否"
            }
        ],
        "RequestId": "8c23f191-5bc6-43f5-9890-21f88e545f6c"
    }
}

示例3 QueryType=2分类

自动分类输入图属于哪种发票类型

输入示例

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

{
    "Query": [
        "增值税专用发票",
        "增值税普通发票",
        "通行费发票"
    ],
    "QueryType": 2,
    "ImageUrl": "https://demo-1400073141.cos.ap-guangzhou.myqcloud.com/%E5%A2%9E%E5%80%BC%E7%A8%8E%E5%8F%91%E7%A5%A8.png?q-sign-algorithm=sha1&q-ak=AKID4-Xu1TJlFcWCFYFcBM0jeYFhiLideyQNzjB1-auWplOZvevH7dhYJUmvalPjJxQj&q-sign-time=1776751051;1776754651&q-key-time=1776751051;1776754651&q-header-list=host&q-url-param-list=&q-signature=b23789a5890773068358aeb44139438305476ecd&x-cos-security-token=2h4y82Xge6IaO54EmvE4bkv7jnUKzcHa8319cf620e8171067cc7ef6ca8617822VQOPSF0rD_E_hBrKn29TH5h5D0EhOeBXrfHCLSAbyKOB4y6kKOr6cv8ytWL3KQ8ROGETurrABAoOBjogE9jrCksk5xn0GOuHmFdFAmUXibaI6mHHLIuN8MZf7u-_CaKnBoRVWVTitlJ2_QJGC01pfhWwirM30MMMiKMZnZ5GnBX3duGLkFIF4THWxpX_XxmVkA2567rXs315V3viCAww83Xs7aYRWqt7R89Gj0HDIPfGLhsNZcUVedZw1vsvqovzjRibsRrfGWRajQ4qcx11ig",
    "SelectModel": 0
}

输出示例

{
    "Response": {
        "Angle": 0,
        "Response": [
            {
                "Answer": "增值税普通发票",
                "QueryInfo": "根据图片内容，该图片最符合以下哪种分类：增值税专用发票；增值税普通发票；通行费发票。只回答 增值税专用发票 / 增值税普通发票 / 通行费发票 ，若均不属于以上所有分类，只输出：均不符合。"
            }
        ],
        "RequestId": "6ed1170d-3eb2-42e4-a052-fd9bf1490402"
    }
}

示例4 QueryType=3总结提炼

总结提炼简历图中与{课程}相关内容

输入示例

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

{
    "Query": [
        "课程"
    ],
    "QueryType": 3,
    "ImageUrl": "https://demo-1400073141.cos.ap-guangzhou.myqcloud.com/10.%20image2.jpg?q-sign-algorithm=sha1&q-ak=AKIDWyvZ0eN6uj2NsBQJn7TdtNs1K05lLJn8ihMENaEKREeZimpybAsYuRbVG1Aootln&q-sign-time=1776824751;1776828351&q-key-time=1776824751;1776828351&q-header-list=host&q-url-param-list=&q-signature=83bb8ce9c768fde565e71b0460e6dbde1b4886f4&x-cos-security-token=xheG1dXFML3tXG5BbL3WBkxVgTMPn53a305890e6c04febe60e215a5a32833a69POGPBv-E8gHNUZW60alPmkc4RfdRY-_t8Ui8YDNXe1cYF6_ToPvP6_zzdNrdcV7IFK2puDFJESTWb5bpdgNFzBYaIqMBzQ5mGNamTbS3zRP0FMQTNpGj-3aq5Y0Nq46WuYcs4KcX29RE6LuZeuUo9ODhoWjqS69N4MmunTB2fJwpu9GqgkKpLu98DaKKIFpxF_12tfVf4_RuH1xbATmJAMl4h1-ni7Ga25th3WlWlDgJ1WE15lVSJueMoPdmbNvvOQBuBl4zTGtc3AEy3MFKmg",
    "SelectModel": 1
}

输出示例

{
    "Response": {
        "Angle": 0,
        "Response": [
            {
                "Answer": "主要课程及成绩：港口机械发动机构造与维修1（60分）、钳工（85分）、底盘构造与维修（79分）、港口机械发动机构造与维修2（60分）、机械制图（84分）、液压与液力传动（84分）、数学（80分）、机械基础（79分）、艺术欣赏（90分）、历史（82分）、港口机械底盘构造与维修1（60分）、体育（81分）、管理学基础（80分）、港口机械底盘构造与维修（60分）、计算机应用（65分）",
                "QueryInfo": "根据图片内容，总结提炼课程的核心信息，字数精简，只总结图片上有的信息，不要做其他增添。若课程与图片内容毫无相关性，则输出：无相关内容"
            }
        ],
        "RequestId": "e0c8e1fb-d83c-44b9-b260-5bdeefbbe32d"
    }
}

示例5 QueryType=4信息提取

提取简历图的字段

输入示例

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

{
    "QueryType": 4,
    "ImageUrl": "https://demo-1400073141.cos.ap-guangzhou.myqcloud.com/10.%20image2.jpg?q-sign-algorithm=sha1&q-ak=AKIDyrWqLRrQ1Si19TU6ChKv5DLrPKFR77A08bhHdfoRqNgh_DetWbaFzNxDyQN3a9yh&q-sign-time=1776751694;1776755294&q-key-time=1776751694;1776755294&q-header-list=host&q-url-param-list=&q-signature=522cd0947c759fa4009f63966bee66db86ac4ef2&x-cos-security-token=2h4y82Xge6IaO54EmvE4bkv7jnUKzcHa0e6c6fb81df434070af64a0a8df5dfdcVQOPSF0rD_E_hBrKn29TH1-5bw1mGNKKOEOlkk-oOZ9t8PtjUi79GCHH6m2DNTkdd0-5fVKyM_EVPGdCNv0DJTB4lEHJcCafNflaZq-JD2EcUcfS118k6r09iTKm7gkyTZ95M_CsNj8UfISHcpx6XpDKShN_5NzJ7yjlWR2SYFmPvLaQHrOse4ErhU_MGkFcBYNk7igraUh31Bm79-s2rj75E0hIkiNDg_KxvmXJfc1Jdv0F-yXZkLN9PrpR6qp7iJR0Qp0FnAuyxtbxekob9g",
    "SchemaItems": [
        {
            "KeyName": "姓名",
            "KeyType": 0,
            "KeyPrompt": "具体名字"
        },
        {
            "KeyName": "出生年月",
            "KeyType": 0,
            "KeyPrompt": "如，2026年1月"
        },
        {
            "KeyName": "主要课程",
            "KeyType": 1,
            "KeyPrompt": "课程列表，有课程名称，以及成绩",
            "SubItems": [
                {
                    "KeyName": "课程",
                    "KeyType": 0,
                    "KeyPrompt": "课程名称，如政治"
                },
                {
                    "KeyName": "成绩",
                    "KeyType": 0,
                    "KeyPrompt": "具体分数，如99"
                }
            ]
        }
    ],
    "SelectModel": 0
}

输出示例

{
    "Response": {
        "Angle": 0,
        "RequestId": "d8fe42e3-1b3d-46dc-9784-2eadf081e34a",
        "Response": [
            {
                "ExtractFields": [
                    {
                        "KeyName": "姓名",
                        "KeyPrompt": "具体名字",
                        "KeyType": 0,
                        "KeyValue": "王臣"
                    },
                    {
                        "KeyName": "出生年月",
                        "KeyPrompt": "如，2026年1月",
                        "KeyType": 0,
                        "KeyValue": "2005年1月"
                    },
                    {
                        "KeyName": "主要课程",
                        "KeyPrompt": "课程列表，有课程名称，以及成绩",
                        "KeyType": 1,
                        "SubItems": [
                            {
                                "Groups": [
                                    {
                                        "KeyName": "课程",
                                        "KeyPrompt": "课程名称，如政治",
                                        "KeyType": 0,
                                        "KeyValue": "底盘构造与维修"
                                    },
                                    {
                                        "KeyName": "成绩",
                                        "KeyPrompt": "具体分数，如99",
                                        "KeyType": 0,
                                        "KeyValue": "79"
                                    }
                                ]
                            },
                            {
                                "Groups": [
                                    {
                                        "KeyName": "课程",
                                        "KeyPrompt": "课程名称，如政治",
                                        "KeyType": 0,
                                        "KeyValue": "钳工"
                                    },
                                    {
                                        "KeyName": "成绩",
                                        "KeyPrompt": "具体分数，如99",
                                        "KeyType": 0,
                                        "KeyValue": "85"
                                    }
                                ]
                            },
                            {
                                "Groups": [
                                    {
                                        "KeyName": "课程",
                                        "KeyPrompt": "课程名称，如政治",
                                        "KeyType": 0,
                                        "KeyValue": "港口机械发动机构造与维修1"
                                    },
                                    {
                                        "KeyName": "成绩",
                                        "KeyPrompt": "具体分数，如99",
                                        "KeyType": 0,
                                        "KeyValue": "60"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DownLoadError	文件下载失败。
FailedOperation.ImageDecodeFailed	图片解码失败。
FailedOperation.ImageSizeTooLarge	图片尺寸过大，请参考输入参数中关于图片大小限制的说明。
FailedOperation.OcrFailed	OCR识别失败。
FailedOperation.PDFParseFailed	PDF解析失败。
FailedOperation.ResponseParseFailed	结果解析失败
FailedOperation.UnKnowError	未知错误。
FailedOperation.UnKnowFileTypeError	未知的文件类型。
FailedOperation.UnOpenError	服务未开通。
InvalidParameterValue.InvalidParameterValueLimit	参数值错误。
LimitExceeded.TooLargeFileError	文件内容太大。
ResourceUnavailable.InArrears	账号已欠费。
ResourceUnavailable.ResourcePackageRunOut	账号资源包耗尽。
ResourcesSoldOut.ChargeStatusException	计费状态异常。

通用文字识别Agent

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 QueryType=0全文识别

输入示例

输出示例

示例2 QueryType=1判断

输入示例

输出示例

示例3 QueryType=2分类

输入示例

输出示例

示例4 QueryType=3总结提炼

输入示例

输出示例

示例5 QueryType=4信息提取

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码