tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
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
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary
DocumentaçãoCloud Object StorageAPI DocumentationData Processing APIsAI-Based Content RecognitionImage OCROCR Asynchronous TaskCreating Templates

Creating Templates

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 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>

Anterior: Task CallbackPróximo: Updating a Template

Ajuda e Suporte

Esta página foi útil?

comentários