数据万象
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>数据万象>API 文档>AI 内容识别>图片文字识别(OCR）>OCR 异步任务>提交任务

提交任务

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

我的收藏

本页目录：

功能描述

提交一个 OCR 任务。

授权说明

通过子账号使用时，需要授予 ci:CreateMediaJobs权限，详情请参见 数据万象 action。
子账号使用异步处理接口时，需要授予 cam:passrole权限，异步处理接口会通过 CAM 的“角色”进行 COS 的资源读写操作，PassRole 权限用于传递角色， 具体请查看 访问管理-写操作-PassRole 接口。

服务开通

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

使用限制

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

费用说明

该接口为付费服务，产生的费用将由数据万象收取，详细计费说明可参见 内容识别费用。


请求

请求示例

POST /jobs 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>
    <Input>
        <Object>input/test.jpg</Object>
    </Input>
    <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON</CallBackFormat>
</Request>
具体的数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Request
无
保存请求的容器
Container
是
Container 类型 Request 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Tag
Request
创建任务的 Tag：ImageOCR
String
是
Input
Request
待操作的媒体信息
Container
是
Operation
Request
操作规则
Container
是
CallBack
Request
任务回调地址，优先级高于队列的回调地址。设置为 no 时，表示队列的回调地址不产生回调
String
否
CallBackFormat
Request
任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式
String
否
CallBackType
Request
任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型
String
否
CallBackMqConfig
Request
任务回调 TDMQ 配置，当 CallBackType 为 TDMQ 时必填。详情请参见 CallBackMqConfig
Container
否
Container 类型 Input 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Object
Request.Input
待处理的文件名
String
否
Container 类型 Operation 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
TemplateId
Request.Operation
OCR 模板 ID
String
否
UserData
Request.Operation
透传用户信息, 可打印的 ASCII 码, 长度不超过1024
String
否
JobLevel
Request.Operation
任务优先级，级别限制：0 、1 、2 。级别越大任务优先级越高，默认为0
String
否
ImageOCR
Request.Operation
OCR 参数, 同创建 OCR 模板接口中的 Request.ImageOCR
Container
否
注意
OCR 参数必须设置，可以通过 TemplateId 或 ImageOCR 设置，TemplateId 优先级更高。

响应

响应头

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

响应体

该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
    <JobsDetail>
        <Code>Success</Code>
        <CreationTime>2023-11-25T08:47:39+0800</CreationTime>
        <EndTime>-</EndTime>
        <Input>
            <BucketId>test-1234567890</BucketId>
            <Object>pic/ocr1.png</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <JobId>a3c193f288b2c11eeb60f39de2f86f409</JobId>
        <Message/>
        <Operation>
            <JobLevel>0</JobLevel>
            <TemplateId>t1a545cd125ea04ec7a3cd455065d601cc</TemplateId>
            <TemplateName>ImageOCR-34</TemplateName>
        </Operation>
        <QueueId>pcaffdc4229a543b296b10b22586a1e57</QueueId>
        <StartTime>-</StartTime>
        <State>Submitted</State>
        <Tag>ImageOCR</Tag>
    </JobsDetail>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点 Response 的内容：
节点名称（关键字）
父节点
描述
类型
JobsDetail
Response
任务的详细信息
Container 数组
Container 节点
JobsDetail
的内容：
节点名称（关键字）
父节点
描述
类型
Code
Response.JobsDetail
错误码，只有 State 为 Failed 时有意义
String
CreationTime
Response.JobsDetail
任务的创建时间
String
EndTime
Response.JobsDetail
任务的结束时间
String
Input
Response.JobsDetail
该任务的输入资源地址
Container
JobId
Response.JobsDetail
新创建任务的 ID
String
Message
Response.JobsDetail
错误描述，只有 State 为 Failed 时有意义
String
Operation
Response.JobsDetail
该任务的规则
Container
QueueId
Response.JobsDetail
任务所属的 队列 ID
String
StartTime
Response.JobsDetail
任务的开始时间
String
State
Response.JobsDetail
任务状态
Submitted：已提交，待执行
Running：执行中
Success：执行成功
Failed：执行失败
Pause：任务暂停，当暂停队列时，待执行的任务会变为暂停状态
Cancel：任务被取消执行
String
Tag
Response.JobsDetail
新创建任务的 Tag：ImageOCR
String
Container 节点 Input 的内容：
节点名称（关键字）
父节点
描述
类型
Region
Response.JobsDetail.Input
存储桶的地域
String
Object
Response.JobsDetail.Input
输出结果的文件名
String
BucketId
Response.JobsDetail.Input
存储结果的存储桶
String
Container 节点 Operation 的内容：
节点名称（关键字）
父节点
描述
类型
JobLevel
Response.JobsDetail.Operation
任务优先级
String
TemplateId
Response.JobsDetail.Operation
任务的模板 ID
String
TemplateName
Response.JobsDetail.Operation
任务的模板名称, 当 TemplateId 存在时返回
String
ImageOCR
Response.JobsDetail.Operation
同请求中的 Request.Operation.ImageOCR
Container
Detection
Response.JobsDetail.Operation
OCR结果
Container
UserData
Response.JobsDetail.Operation
透传用户信息
String
Container 节点 Detection 的内容：
节点名称（关键字）
父节点
描述
类型
TextDetections
Response.JobsDetail.Operation.Detection
检测到的文本信息
Container 数组
Language
Response.JobsDetail.Operation.Detection
检测到的语言类型
String
Angel
Response.JobsDetail.Operation.Detection
图片旋转角度（角度制），文本的水平方向为0°；顺时针为正，逆时针为负
String
PdfPageSize
Response.JobsDetail.Operation.Detection
图片为 PDF 时，返回 PDF 的总页数
Int
Container 节点 TextDetections 的内容：
节点名称（关键字）
父节点
描述
类型
DetectedText
Response.JobsDetail.Operation.Detection.TextDetections
识别出的文本行内容
String
Confidence
Response.JobsDetail.Operation.Detection.TextDetections
置信度 0 ~100
Int
Polygon
Response.JobsDetail.Operation.Detection.TextDetections
文本行坐标，以四个顶点坐标表示
Container 数组
ItemPolygon
Response.JobsDetail.Operation.Detection.TextDetections
文本行在旋转纠正之后的图像中的像素坐标，表示为（左上角x, 左上角y，宽 width，高 height）
Container 数组
Words
Response.JobsDetail.Operation.Detection.TextDetections
识别出来的单字信息包括单字（包括单字 Character 和单字置信度 confidence）
Container 数组
WordPolygon
Response.JobsDetail.Operation.Detection.TextDetections
字的坐标数组，以四个顶点坐标表示。注意：此字段可能返回 null，表示取不到有效值。支持识别的类型，当 handwriting 时生效
Container 数组
Container 节点 Polygon 的内容：
节点名称（关键字）
父节点
描述
类型
X
Response.JobsDetail.Operation.Detection.Polygon
横坐标
Int
Y
Response.JobsDetail.Operation.Detection.Polygon
纵坐标
Int
Container 节点 ItemPolygon 的内容：
节点名称（关键字）
父节点
描述
类型
X
Response.JobsDetail.Operation.Detection.ItemPolygon
左上角X
Int
Y
Response.JobsDetail.Operation.Detection.ItemPolygon
左上角Y
Int
Width
Response.JobsDetail.Operation.Detection.ItemPolygon
宽
Int
Height
Response.JobsDetail.Operation.Detection.ItemPolygon
高
Int
Container 节点 Words 节点的内容：
节点名称（关键字）
父节点
描述
类型
Confidence
Response.JobsDetail.Operation.Detection.Words
置信度 0 ~100
Int
Character
Response.JobsDetail.Operation.Detection.Words
候选字
String
WordCoordPoint
Response.JobsDetail.Operation.Detection.Words
单字在原图中的四点坐标，当识别类型为 general、accurate 时生效
Container 数组
Container 节点 WordCoordPoint 节点的内容：
节点名称（关键字）
父节点
描述
类型
WordCoordinate
Response.JobsDetail.Operation.Detection.Words.WordCoordPoint
单字在原图中的坐标，以四个顶点坐标表示，以左上角为起点，顺时针返回
Container 数组
Container 节点 WordCoordinate 节点的内容：
节点名称（关键字）
父节点
描述
类型
X
Response.JobsDetail.Operation.Detection.Words.WordCoordPoint.WordCoordinate
横坐标
Int
Y
Response.JobsDetail.Operation.Detection.Words.WordCoordPoint.WordCoordinate
纵坐标
Int
Container 节点 Location 节点的内容：
节点名称（关键字）
父节点
描述
类型
LeftTop
Response.JobsDetail.Operation.Detection.WordPolygon
左上顶点坐标
Container 数组
RightTop
Response.JobsDetail.Operation.Detection.WordPolygon
右上顶点坐标
Container 数组
LeftBottom
Response.JobsDetail.Operation.Detection.WordPolygon
左下顶点坐标
Container 数组
RightBottom
Response.JobsDetail.Operation.Detection.WordPolygon
右上顶点坐标
Container 数组
Container 节点 LeftTop 节点的内容：
节点名称（关键字）
父节点
描述
类型
X
Response.JobsDetail.Operation.Detection.WordPolygon.LeftTop
横坐标
Int
Y
Response.JobsDetail.Operation.Detection.WordPolygon.LeftTop
纵坐标
Int
Container 节点 RightTop，RightBottom，LeftBottom 节点的内容与 LeftTop 相同：

错误码

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

实际案例

请求1：使用视频目标检测模板 ID

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

<Request>
    <Tag>ImageOCR</Tag>
    <Input>
        <Object>input/test.jpg</Object>
    </Input>
    <Operation>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON</CallBackFormat>
</Request>

响应1

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <JobsDetail>
        <Code>Success</Code>
        <CreationTime>2023-11-25T08:47:39+0800</CreationTime>
        <EndTime>-</EndTime>
        <Input>
            <BucketId>test-1234567890</BucketId>
            <Object>pic/ocr1.png</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <JobId>a3c193f288b2c11eeb60f39de2f86f409</JobId>
        <Message/>
        <Operation>
            <JobLevel>0</JobLevel>
            <TemplateId>t1a545cd125ea04ec7a3cd455065d601cc</TemplateId>
            <TemplateName>ImageOCR-34</TemplateName>
            <UserData>This is my data.</UserData>
        </Operation>
        <QueueId>pcaffdc4229a543b296b10b22586a1e57</QueueId>
        <StartTime>-</StartTime>
        <State>Submitted</State>
        <Tag>ImageOCR</Tag>
    </JobsDetail>
</Response>

请求2：使用视频目标检测处理参数

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

<Request>
    <Tag>ImageOCR</Tag>
    <Input>
        <Object>input/test.jpg</Object>
    </Input>
    <Operation>
        <ImageOCR>
            <Type>general</Type>
            <LanguageType>zh</LanguageType>
            <IsPdf>true</IsPdf>
            <PdfPageNumber>2</PdfPageNumber>
            <IsWord>true</IsWord>
        </ImageOCR>
        <UserData>This is my data.</UserData>
        <JobLevel>0</JobLevel>
    </Operation>
    <CallBack>http://callback.demo.com</CallBack>
    <CallBackFormat>JSON</CallBackFormat>
</Request>

响应2

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 230
Connection: keep-alive
Date: Mon, 28 Jun 2022 15:23:12 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <JobsDetail>
        <Code>Success</Code>
        <CreationTime>2023-11-25T08:47:39+0800</CreationTime>
        <EndTime>-</EndTime>
        <Input>
            <BucketId>test-1234567890</BucketId>
            <Object>pic/ocr1.png</Object>
            <Region>ap-chongqing</Region>
        </Input>
        <JobId>a3c193f288b2c11eeb60f39de2f86f409</JobId>
        <Message/>
        <Operation>
            <JobLevel>0</JobLevel>
            <UserData>This is my data.</UserData>
            <ImageOCR>
                <Type>general</Type>
                <LanguageType>zh</LanguageType>
                <IsPdf>true</IsPdf>
                <PdfPageNumber>2</PdfPageNumber>
                <IsWord>true</IsWord>
            </ImageOCR>
        </Operation>
        <QueueId>pcaffdc4229a543b296b10b22586a1e57</QueueId>
        <StartTime>-</StartTime>
        <State>Submitted</State>
        <Tag>ImageOCR</Tag>
    </JobsDetail>
</Response>

中国站
文档反馈
文档活动
message-icon联系我们
目录