API 中心
有奖：语音产品征文挑战赛等你来> HOT
文档中心 > API 中心 > 数据万象 > AI 内容识别 > 图片文字识别(OCR） > OCR 异步任务 > 创建模板

创建模板

最近更新时间：2024-04-09 15:54:35

我的收藏

本页目录：

功能描述

创建OCR模板。

授权说明

通过子账号使用时，需要授予 ci:CreateMediaTemplate权限，详情请参见 数据万象 action。

服务开通

使用该功能需提前开通数据万象，并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通 AI 内容识别服务 。详情请参见 开通 AI 内容识别服务。

使用限制

使用该接口时，请先确认相关限制条件。详情请参见 使用限制。


请求

请求示例

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>
说明
Authorization: Auth String，详情请参见 请求签名 文档。

请求头

此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

请求体

该请求操作的实现需要有如下请求体。
<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>
具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Request
无
保存请求的容器
Container
是
Container 类型
Request
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Tag
Request
模板类型：ImageOCR
String
是
Name
Request
模板名称，仅支持中文、英文、数字、_、-和*，长度不超过 64
String
是
ImageOCR
Request
OCR参数
Container
是
Container 类型
ImageOCR
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
默认值
是否必选
Type
Request.ImageOCR
general 表示通用印刷体识别
accurate 表示印刷体高精度
efficient 表示印刷体精简版
fast 表示印刷体高速版
handwriting 表示手写体识别
string
general
否
LanguageType
Request.ImageOCR
识别语言类型，自动识别语言类型，同时支持自选语言种类，默认中英文混合(zh)，各种语言均支持与英文混合的文字识别，type 值为 general 时有效。
zh: 中英混合
zh_rare: 支持英文、数字、中文生僻字、繁体字、特殊符号等
auto: 自动
mix: 混合语种
jap: 日语
kor: 韩语
spa: 西班牙语
fre: 法语
ger: 德语
por: 葡萄牙语
vie: 越语
may: 马来语
rus: 俄语
ita: 意大利语
hol: 荷兰语
sew: 瑞典语
fin: 芬兰语
dan: 丹麦语
nor: 挪威语
hun: 匈牙利语
tha: 泰语
hi: 印地语
ara: 阿拉伯语
string
zh
否
IsPdf
Request.ImageOCR
type 值为 general，fast 时有效，表示是否开启 PDF 识别，开启后可同时支持图片和 PDF 的识别。
string
false
否
PdfPageNumber
Request.ImageOCR
type 值为 general，fast 时有效，表示需要识别的 PDF 页面的对应页码，仅支持 PDF 单页识别，当上传文件为 PDF 且 IsPdf 参数值为 true 时有效。
string
1
否
IsWord
Request.ImageOCR
type 值为 general，accurate 时有效，表示识别后是否需要返回单字信息。
string
false
否
EnableWordPolygon
Request.ImageOCR
type 值为 handwriting 时有效，表示是否开启单字的四点定位坐标输出
string
false
否
说明
ImageOCR 节点中至少传入一个参数，不能所有参数同时为空。

响应

响应头

此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<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>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点
Response
的内容：
节点名称（关键字）
父节点
描述
类型
RequestId
Response
请求的唯一 ID
String
Template
Response
保存模板详情的容器
Container
Container 节点
Template
的内容：
节点名称（关键字）
父节点
描述
类型
Tag
Response.Template
模板类型，ImageOCR
String
Name
Response.Template
模板名称
String
TemplateId
Response.Template
模板 ID
String
CreateTime
Response.Template
创建时间
String
UpdateTime
Response.Template
更新时间
String
BucketId
Response.Template
模板所属存储桶
String
Category
Response.Template
模板属性，Custom 或者 Official
String
ImageOCR
Response.Template
同请求体中的 Request.ImageOCR
Container

错误码

该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

实际案例

请求

POST /template HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
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>

响应

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>

中国站