tencent cloud

Cloud Infinite

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Product Overview
Product Strengths
Use Cases
Feature Overview
Regions and Domains
Specifications and Limits
Billing
Billing Overview
Billing Mode
Billable Items
Free Tier
Payment Overdue
Viewing Bill Details
FAQs
Getting Started
Registering and Logging In
Bind Bucket
Uploading and Processing File
Downloading and Deleting Images
Unbinding Buckets
Using CI via COS
Features
Image Processing
Media Processing
Content Moderation
AI Content Recognition
File Processing
Smart Voice
File processing
User Guide
Overview
Bucket Management
Smart Toolbox
Job and Workflow
Data Monitoring
Usage statistics
Use Cases
Copyright Protection Solutions
Image Processing Practices
Working with API Authorization Policies
Workflow Practices
API Documentation
API Overview
Structure
Common Request Headers
Common Response Headers
Activate Vast Service
Image Processing
AI-Based Content Recognition
Smart Audio
Media Processing
Content Moderation
Document Processing
File Processing
Job and Workflow
Cloud Virus Detection
Error Codes
Request Signature
SDK Documentation
SDK Overview
Android SDK
iOS SDK
COS Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Go SDK
COS iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
Mini Program SDK
Personal Information Protection Policy for SDK
Security and Compliance
Permission ‍Management
FAQs
Basic Settings
Document Processing
Media Processing
Content Recognition
Smart Audio
Agreements
Service Level Agreement
Contact Us
Glossary
DocumentationCloud InfiniteAPI DocumentationAI-Based Content RecognitionImage OCROCR Asynchronous TaskCreating Templates

Creating Templates

PDF
Focus Mode
Font Size
Last updated: 2025-09-09 20:02:19

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>

Previous Topic: Task CallbackNext Topic: Updating a Template

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback