tencent cloud

对象存储

动态与公告
产品动态
产品公告
产品简介
产品概述
功能概览
应用场景
产品优势
基本概念
地域和访问域名
规格与限制
产品计费
计费概述
计费方式
计费项
免费额度
计费示例
查看和下载账单
欠费说明
常见问题
快速入门
控制台快速入门
COSBrowser 快速入门
用户指南
创建请求
存储桶
对象
数据管理
批量处理
全球加速
监控与告警
运维中心
数据处理
内容审核
智能工具箱
数据工作流
应用集成
工具指南
工具概览
环境安装与配置
COSBrowser 工具
COSCLI 工具
COSCMD 工具
COS Migration 工具
FTP Server 工具
Hadoop 工具
COSDistCp 工具
HDFS TO COS 工具
GooseFS-Lite 工具
在线辅助工具
自助诊断工具
实践教程
概览
访问控制与权限管理
性能优化
使用 AWS S3 SDK 访问 COS
数据容灾备份
域名管理实践
图片处理实践
COS 音视频播放器实践
工作流实践
数据直传
内容审核实践
数据安全
数据校验
大数据实践
COS 成本优化解决方案
在第三方应用中使用 COS
迁移指南
本地数据迁移至 COS
第三方云存储数据迁移至 COS
以 URL 作为源地址的数据迁移至 COS
COS 之间数据迁移
Hadoop 文件系统与 COS 之间的数据迁移
数据湖存储
云原生数据湖
元数据加速
数据加速器 GooseFS
数据处理
数据处理概述
图片处理
媒体处理
内容审核
文件处理
文档处理
故障处理
获取 RequestId 操作指引
通过外网上传文件至 COS 缓慢
访问 COS 时返回403错误码
资源访问异常
POST Object 常见异常
API 文档
简介
公共请求头部
公共响应头部
错误码
请求签名
操作列表
Service 接口
Bucket 接口
Object 接口
批量处理接口
数据处理接口
任务与工作流
内容审核接口
云查毒接口
SDK 文档
SDK 概览
准备工作
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
小程序 SDK
错误码
鸿蒙(Harmony) SDK
终端 SDK 质量优化
安全与合规
数据容灾
数据安全
访问管理
常见问题
热门问题
一般性问题
计费计量问题
域名合规问题
存储桶配置问题
域名和 CDN 问题
文件操作问题
日志监控问题
权限管理问题
数据处理问题
数据安全问题
预签名 URL 问题
SDK 类问题
工具类问题
API 类问题
服务协议
Service Level Agreement
隐私政策
数据处理和安全协议
联系我们
词汇表

Creating Templates

PDF
聚焦模式
字号
最后更新时间: 2026-01-09 22:22:20

Feature Description

Create an OCR template.

Authorization Description

When used by a sub-account, the ci:CreateMediaTemplate permission is required. For details, see Cloud Infinite action.

Service Activation

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Bind Bucket.
Use this feature requires enabling AI Content Recognition Service in advance via console or API. For details, see Enable AI Content Recognition Service.

Use Limits

When using this API, please first confirm the relevant restrictions. For details, see Usage Limits.


Request

Request sample

POST /template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>
Note:
Authorization: Auth String. For details, see Request Signature document.

Request header.

This API only uses common request headers. For details, see Common Request Headers documentation.

Request body.

The implementation of this request operation requires the following request body.
<Request>
<Tag>ImageOCR</Tag>
<Name>TemplateName</Name>
<ImageOCR>
<Type>general</Type>
<LanguageType>zh</LanguageType>
<IsPdf>true</IsPdf>
<PdfPageNumber>2</PdfPageNumber>
<IsWord>true</IsWord>
</ImageOCR>
</Request>
The data are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Request
None.
Container for saving requests
Container
Yes
The specific data description for the
Request
Container type is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Tag
Request
Template type: ImageOCR
String
Yes
Name
Request
Template name, only supports Chinese, English, digits, _, -, and *, length not exceeding 64
String
Yes
ImageOCR
Request
OCR parameter
Container
Yes
The specific data description for the
ImageOCR
Container type is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Type
Request.ImageOCR
general printed text recognition
accurate print hand with high precision
efficient Simplified edition Printed text
fast Print Hand
handwriting refers to handwritten text recognition
string
general
No
LanguageType
Request.ImageOCR
Identify language type Automatically identify language type Simultaneously support selected language types Default is Chinese-English mix (zh) Supports text recognition mixed with English for various languages Valid when type value is general
mixed Chinese and English
Support English, digits, rare Chinese characters, traditional Chinese characters, special symbols
auto
Mixed language
jap: Japanese
Create and bind a policy Query an instance Reset the access password of an instance
spa: Spanish
Créer et lier une stratégie Interroger une instance Réinitialiser le mot de passe d'accès d'une instance
Create and bind a policy Query an instance Reset the access password of an instance
por: Portuguese
vie: Vietnamese
may: Malay
Create and bind a policy Query an instance Reset the access password of an instance
Creare e associare un criterio Consultare un'istanza Reimpostare la password di accesso di un'istanza
Dutch
sew: Swedish
fin: Finnish
dan: Danish
nor: Norwegian
Hungarian
tha: Thai
hi: Hindi
{ara: Arabic}
string
zh
No
IsPdf
Request.ImageOCR
Valid when type is general or fast. Indicates whether PDF recognition is enabled. Once enabled, it can simultaneously support image and PDF recognition.
string
false
No
PdfPageNumber
Request.ImageOCR
Valid when type is general or fast. Indicates the corresponding page number of the PDF page to be recognized. Only supports single page recognition of PDF. Valid when the uploaded file is PDF and the IsPdf parameter value is true.
string
1
No
IsWord
Request.ImageOCR
Valid when type is general or accurate. Indicates whether single character information needs to be returned after recognition.
string
false
No
EnableWordPolygon
Request.ImageOCR
Valid when type is handwriting, indicates whether to enable the output of four-point positioning coordinates for individual characters.
string
false
No
Note:
In the ImageOCR node, at least one parameter must be input. All parameters cannot be empty at the same time.

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
<RequestId>NjQ0NGNlNDZfMThhYTk0MGFfY*********</RequestId>
<Template>
<Tag>ImageOCR</Tag>
<Name>TemplateName</Name>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
<BucketId>test-1234567890</BucketId>
<Category>Custom</Category>
<ImageOCR>
<Type>general</Type>
<LanguageType>zh</LanguageType>
<IsPdf>true</IsPdf>
<PdfPageNumber>2</PdfPageNumber>
<IsWord>true</IsWord>
<EnableWordPolygon>false</EnableWordPolygon>
</ImageOCR>
</Template>
</Response>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node
Response
content:
Node Name (Keyword)
Parent Node
Description
Type
RequestId
Response
unique request ID
String
Template
Response
Container for saving template details
Container
Container node
Template
content:
Node Name (Keyword)
Parent Node
Description
Type
Tag
Response.Template
Template type: ImageOCR
String
Name
Response.Template
Template Name
String
TemplateId
Response.Template
Template ID
String
CreateTime
Response.Template
Creation time
String
UpdateTime
Response.Template
Update time
String
BucketId
Response.Template
Template's bucket
String
Category
Response.Template
Template property, Custom or Official
String
ImageOCR
Response.Template
in the request body's Request.ImageOCR
Container

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Request

POST /template HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************
Host: test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 1666
Content-Type: application/xml

<Request>
<Tag>ImageOCR</Tag>
<Name>TemplateName</Name>
<ImageOCR>
<Type>general</Type>
<LanguageType>zh</LanguageType>
<IsPdf>true</IsPdf>
<PdfPageNumber>2</PdfPageNumber>
<IsWord>true</IsWord>
</ImageOCR>
</Request>

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<Template>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Name>TemplateName</Name>
<Tag>ImageOCR</Tag>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
<BucketId>test-1234567890</BucketId>
<Category>Custom</Category>
<ImageOCR>
<Type>general</Type>
<LanguageType>zh</LanguageType>
<IsPdf>true</IsPdf>
<PdfPageNumber>2</PdfPageNumber>
<IsWord>true</IsWord>
<EnableWordPolygon>false</EnableWordPolygon>
</ImageOCR>
</Template>
</Response>


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈