1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
用于作文批改Agent查询任务。基于业界领先的千亿参数多模态大模型技术,提供中英文手写作文的精准批改端到端服务。核心功能涵盖错别字智能识别、好词好句点评、错句纠错,并能够在原文中定位至具体段落与字符位置,同时提供详细的修改建议与优化内容。此能力是作业批改场景中的核心模块。
默认接口请求并发限制:2次/分钟。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeMarkEssayAgentJob。 |
| Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| JobId | 否 | String | 任务唯一ID。由服务端生成。 示例值:"1334797167793684480" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Angle | Float | 图片旋转角度(角度制),文本的水平方向为 0;顺时针为正,逆时针为负。 示例值:1.0 |
| SentenceSuggests | Array of MarkEssaySuggestions | 配置结构化文本信息。 |
| ErrorCode | String | 任务执行错误码。当任务状态不为 FAIL 时,该值为""。 示例值:FailedOperation.PDFParseFailed |
| ErrorMessage | String | 任务执行错误信息。当任务状态不为 FAIL 时,该值为""。 示例值:PDF解析失败。 |
| JobStatus | String | 任务状态。WAIT:等待中,RUN:执行中,FAIL:任务失败,DONE:任务成功 示例值:DONE |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用失败示例
调用失败示例
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeExtractDocAgentJob
<公共请求参数>
{
"JobId": "1334797167793684480"
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.InvalidParameterValueLimit",
"Message": "JobId不存在。"
},
"RequestId": "b4074f5b-6773-4702-a4b1-bc719f9ce09b"
}
}
示例2 调用成功示例
调用成功示例
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeExtractDocAgentJob
<公共请求参数>
{
"JobId": "1402607291428618240"
}
输出示例
{
"Response": {
"Angle": 0,
"ErrorCode": "",
"ErrorMessage": "",
"JobStatus": "DONE",
"RequestId": "ae9adcda-4452-497c-b1a1-47149920705d",
"SentenceSuggests": [
{
"ID": 0,
"Message": "标题中引号使用不当,应为前双引号、后双引号,且“急性子”后不应再有一个前引号。",
"Origin": "“急性子““妈妈",
"Positions": [
{
"Position": [
560,
86,
895,
86,
895,
137,
560,
137
]
}
],
"Replace": "“急性子”妈妈",
"SubType": "错别字",
"Type": "词汇层面"
},
{
"ID": 1,
"Message": "“玩儿啦”在口语中常见,但在书面语中,“啦”是“了”和“啊”的合音,这里表示疑问语气,用“呢”更规范。",
"Origin": "玩儿啦",
"Positions": [
{
"Position": [
623,
174,
753,
174,
753,
201,
623,
201
]
}
],
"Replace": "玩呢",
"SubType": "词语误用",
"Type": "词汇层面"
},
{
"ID": 2,
"Message": "引号使用错误,后引号应为”而非“。",
"Origin": "“急性子“",
"Positions": [
{
"Position": [
560,
86,
769,
86,
769,
137,
560,
137
]
}
],
"Replace": "“急性子”",
"SubType": "错别字",
"Type": "词汇层面"
},
{
"ID": 3,
"Message": "并列的定语之间应该使用顿号,而非逗号。",
"Origin": "长长的,弯弯的卷发",
"Positions": [
{
"Position": [
1050,
250,
1275,
250,
1275,
280,
1050,
280
]
},
{
"Position": [
124,
325,
305,
325,
305,
353,
124,
353
]
}
],
"Replace": "长长的、弯弯的卷发",
"SubType": "标点误用",
"Type": "词汇层面"
},
{
"ID": 4,
"Message": "这句话通过“炯炯有神”、“闪烁着智慧的光芒”等词语,生动形象地描绘了妈妈的眼睛,并将外貌特征与内在智慧(轻松解数学题)巧妙联系起来,使人物形象更加丰满、具体。",
"Origin": "我的妈妈长着一头长长的,弯弯的卷发,一双炯炯有神的眼睛中,闪烁着智慧的光芒,就连一道很难的数学题,她也可以轻松算出答案。",
"Positions": [
{
"Position": [
689,
250,
1275,
250,
1275,
280,
689,
280
]
},
{
"Position": [
124,
325,
1253,
325,
1253,
353,
124,
353
]
},
{
"Position": [
112,
401,
1121,
401,
1121,
432,
112,
432
]
}
],
"Replace": "",
"SubType": "优美句子",
"Type": "语句层面"
},
{
"ID": 5,
"Message": "“头痛”和“头疼”在表示“感到为难或讨厌”时通用,但“头疼”更常用于口语化表达,与上下文风格更一致。此处为建议性修改。",
"Origin": "头痛",
"Positions": [
{
"Position": [
443,
470,
536,
470,
536,
509,
443,
509
]
}
],
"Replace": "头疼",
"SubType": "词语误用",
"Type": "词汇层面"
},
{
"ID": 6,
"Message": "“头发也很急”搭配不当。想表达的是“因为急性子,连头发都急白了”,可以用“急得”来连接原因和结果,使表达更准确。",
"Origin": "很急",
"Positions": [
{
"Position": [
972,
713,
1067,
713,
1067,
751,
972,
751
]
}
],
"Replace": "急得",
"SubType": "词语误用",
"Type": "词汇层面"
},
{
"ID": 7,
"Message": "“许多的头发”略显啰嗦,“不少头发”或“好多头发”更简洁自然。",
"Origin": "许多的头发",
"Positions": [
{
"Position": [
1259,
713,
1307,
713,
1307,
751,
1259,
751
]
},
{
"Position": [
102,
792,
278,
792,
278,
842,
102,
842
]
}
],
"Replace": "不少头发",
"SubType": "表达不佳",
"Type": "词汇层面"
},
{
"ID": 8,
"Message": "这句话运用了拟人和夸张的修辞手法,将妈妈的“急性子”人格化到头发上,说“头发也很急”以至于变白,充满童趣和想象力,生动地突出了妈妈性格特点,表达非常新颖、可爱。",
"Origin": "而且妈妈是个急性子,她的头发也很急,因为有许多的头发已经变白了!",
"Positions": [
{
"Position": [
253,
713,
1307,
713,
1307,
751,
253,
751
]
},
{
"Position": [
102,
792,
541,
792,
541,
842,
102,
842
]
}
],
"Replace": "",
"SubType": "优美句子",
"Type": "语句层面"
},
{
"ID": 9,
"Message": "根据下文“对外婆说”,这里指的是“外婆家”。“婆家”通常指丈夫的母亲家,容易产生歧义。",
"Origin": "婆家",
"Positions": [
{
"Position": [
188,
953,
286,
953,
286,
1007,
188,
1007
]
}
],
"Replace": "外婆家",
"SubType": "词语误用",
"Type": "词汇层面"
},
{
"ID": 10,
"Message": "“烦厌”不是一个规范的词语,结合上下文,这里想表达的是“烦恼”或“厌烦”的意思。",
"Origin": "烦厌",
"Positions": [
{
"Position": [
678,
953,
775,
953,
775,
1007,
678,
1007
]
}
],
"Replace": "烦恼",
"SubType": "错别字",
"Type": "词汇层面"
},
{
"ID": 11,
"Message": "“你们家”在口语中对长辈说稍显随意,改为“您那儿”或“外婆家”更显尊重和亲切。",
"Origin": "你们家",
"Positions": [
{
"Position": [
1129,
1034,
1272,
1034,
1272,
1093,
1129,
1093
]
}
],
"Replace": "您那儿",
"SubType": "表达不佳",
"Type": "词汇层面"
},
{
"ID": 12,
"Message": "“理好箱子”口语化较强,在书面语中,“收拾行李”或“整理行装”更规范。",
"Origin": "理好箱子",
"Positions": [
{
"Position": [
466,
1119,
656,
1119,
656,
1179,
466,
1179
]
}
],
"Replace": "收拾好行李",
"SubType": "词语误用",
"Type": "词汇层面"
},
{
"ID": 13,
"Message": "省略号应为“……”(占两个汉字位置),连续多个句号的使用是不规范的。",
"Origin": "。。。。。。",
"Positions": [
{
"Position": [
639,
1204,
896,
1204,
896,
1268,
639,
1268
]
}
],
"Replace": "……",
"SubType": "标点误用",
"Type": "词汇层面"
},
{
"ID": 14,
"Message": "“吊臂”通常指起重机等机械的部件,用于形容人的动作不恰当。“抱着胳膊”是描述人姿势的常用表达。",
"Origin": "抱着吊臂",
"Positions": [
{
"Position": [
224,
1287,
415,
1287,
415,
1361,
224,
1361
]
}
],
"Replace": "抱着胳膊",
"SubType": "词语误用",
"Type": "词汇层面"
},
{
"ID": 15,
"Message": "“实”是错别字,正确的应为“买”。“买好票”意思是已经购买了车票或门票。",
"Origin": "实好票",
"Positions": [
{
"Position": [
1276,
1287,
1324,
1287,
1324,
1361,
1276,
1361
]
},
{
"Position": [
72,
1377,
157,
1377,
157,
1434,
72,
1434
]
}
],
"Replace": "买好票",
"SubType": "错别字",
"Type": "词汇层面"
},
{
"ID": 16,
"Message": "这句话通过“抱着胳膊”、“眉毛一扬”、“嘴一咧”一连串具体的动作和神态描写,非常传神地刻画出了妈妈“急性子”中带着的得意、爽快和一切尽在掌握的神情,画面感极强,让读者仿佛看到了当时的情景。",
"Origin": "她抱着吊臂,眉毛一扬,嘴一咧,对我说:“我早就实好票啦!",
"Positions": [
{
"Position": [
176,
1287,
1324,
1287,
1324,
1361,
176,
1361
]
},
{
"Position": [
72,
1377,
242,
1377,
242,
1434,
72,
1434
]
}
],
"Replace": "",
"SubType": "优美句子",
"Type": "语句层面"
},
{
"ID": 17,
"Message": "引号使用错误,后引号应为”而非“。",
"Origin": "“急性子“",
"Positions": [
{
"Position": [
560,
86,
769,
86,
769,
137,
560,
137
]
}
],
"Replace": "“急性子”",
"SubType": "错别字",
"Type": "词汇层面"
},
{
"ID": 18,
"Message": "“快点儿”是口语化的催促语,在这里做主语不合适。结合句意,可以理解为“妈妈的急性子”或“妈妈‘快’的特点”。",
"Origin": "快点儿",
"Positions": [
{
"Position": [
662,
1464,
809,
1464,
809,
1546,
662,
1546
]
}
],
"Replace": "快",
"SubType": "词语误用",
"Type": "词汇层面"
},
{
"ID": 19,
"Message": "“跟多”是明显的错别字,正确的应为“更多”。",
"Origin": "跟多",
"Positions": [
{
"Position": [
66,
1554,
158,
1554,
158,
1615,
66,
1615
]
}
],
"Replace": "更多",
"SubType": "错别字",
"Type": "词汇层面"
},
{
"ID": 20,
"Message": "原句主语“快点儿”与谓语“让知道”搭配不当,且“让知道”缺少宾语“我”。句子成分残缺,导致表意不清。优化后句子结构完整,逻辑清晰。",
"Origin": "我的“急性子“妈妈的快点儿,让知道要节约时间,做跟多有意义的事。",
"Positions": [
{
"Position": [
171,
1464,
1349,
1464,
1349,
1546,
171,
1546
]
},
{
"Position": [
66,
1554,
433,
1554,
433,
1615,
66,
1615
]
}
],
"Replace": "我的“急性子”妈妈,让我懂得了要节约时间,做更多有意义的事。",
"SubType": "语法硬伤",
"Type": "语句层面"
}
]
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DownLoadError | 文件下载失败。 |
| FailedOperation.ImageSizeTooLarge | 图片尺寸过大,请参考输入参数中关于图片大小限制的说明。 |
| FailedOperation.OcrFailed | OCR识别失败。 |
| FailedOperation.PDFParseFailed | PDF解析失败。 |
| FailedOperation.UnKnowError | 未知错误。 |
| FailedOperation.UnKnowFileTypeError | 未知的文件类型。 |
| FailedOperation.UnOpenError | 服务未开通。 |
| InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
| LimitExceeded.TooLargeFileError | 文件内容太大。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |