API文档
Android_SDK文档
IOS_SDK文档
SDK隐私政策
产品定价
常见问题
中文作文指导（图像识别）
中文作文指导（图像识别） API 简介
说明
Hi，您好，欢迎使用有道智云中文作文指导（图像识别）API 接口服务。
本文档主要针对需要集成 HTTP API 的技术开发工程师，详细描述中文作文指导（图像识别）能力相关的技术内容。
如果您有与我们商务合作的需求，可以通过以下方式联系我们：
商务邮箱： AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问，可以通过以下几种方式联系我们：
客服 QQ：1906538062
智云作文批改技术交流 QQ 1 群: 1092639188
联系邮箱： zhiyun@corp.youdao.com
温馨提示：
- 本文档主要针对开发人员，接入测试前需要获取应用 ID 和应用密钥；如果您还没有，请按照 新手指南 获取。
- 平台向每个账户赠送 50 元的体验金，供用户集成前测试所用，具体资费规则详见中文作文批改服务报价 。
- 使用前请在控制台开通中文作文批改(图像识别)服务.
接口说明
有道 AI 团队自研的基于深度学习网络技术的自动作文指导技术。覆盖学生学习全周期，提供高参考价值的智能批改功能，用户只需要输入中文作文题目要求，智能指导服务即可一键给出针对题目从多个角度的分析结果，从而向用户提供相对全面的作文指导意见。
中文作文指导（图像识别） API HTTPS 地址：
请求方式：POST
> https://openapi.youdao.com/correct_writing_cn_guide_image
协议须知
调用方在集成文本翻译 API 时，请遵循以下规则。
| 规则 | 描述 |
|---|---|
| 传输方式 | HTTPS |
| 请求方式 | POST |
| 字符编码 | 统一使用 UTF-8 编码 |
| 请求格式 | 表单 |
| 响应格式 | JSON |
接口调用参数
调用 API 需要向接口发送以下字段来访问服务。
| 字段名 | 含义 | 备注 | 必填 |
|---|---|---|---|
| appKey | 应用标识（应用 ID） | 控制台创建应用获取 | true |
| curtime | 当前UTC时间戳(秒) | 时间戳 | true |
| salt | 随机字符串 | 1658393284erw | true |
| sign | 签名信息：sha256(appKey+input+salt+密钥) | sha256(appKey+input+salt+密钥) | true |
| signType | 签名类型 | v3 | true |
| requirement | 题目要求（图片的base64编码） | 包含字符数长度限制[4 - 300] | true |
服务配置
| 服务内容 | 说明 |
|---|---|
| 图片识别 | 支持 jpg/png 格式，base64 编码后进行 urlencode，要求 base64 编码后大小不超过 5M，最短边至少 15px，最长边最大 4096px |
错误代码列表
| 错误码 | 含义 |
|---|---|
| 101 | 缺少必填的参数，首先确保必填参数齐全，然后，确认参数书写是否正确。 |
| 102 | 不支持的语言类型 |
| 103 | 翻译文本过长 |
| 104 | 不支持的 API 类型 |
| 105 | 不支持的签名类型 |
| 106 | 不支持的响应类型 |
| 107 | 不支持的传输加密类型 |
| 108 | appKey 无效，注册账号， 登录后台创建应用和实例并完成绑定， 可获得应用 ID 和密钥等信息，其中应用 ID 就是 appKey（ 注意不是应用密钥） |
| 109 | batchLog 格式不正确 |
| 110 | 无相关服务的有效实例，应用没有绑定服务实例，可以新建服务实例，绑定服务实例。注：某些服务的翻译结果发音需要 tts 实例，需要在控制台创建语音合成实例绑定应用后方能使用。 |
| 111 | 开发者账号异常 |
| 201 | 解密失败，可能为 DES,BASE64,URLDecode 的错误 |
| 202 | 签名检验失败，如果确认应用 ID 和应用密钥的正确性，仍返回 202，一般是编码问题。请确保翻译文本 q 为 UTF-8 编码. |
| 203 | 访问 IP 地址不在可访问 IP 列表 |
| 205 | 请求的接口与应用的平台类型不一致，确保接入方式（Android SDK、IOS SDK、API）与创建的应用平台类型一致。 |
| 206 | 因为时间戳无效导致签名校验失败 |
| 207 | 重放请求 |
| 301 | 辞典查询失败 |
| 302 | 小语种查询失败 |
| 303 | 服务端的其它异常 |
| 401 | 账户已经欠费停 |
| 411 | 访问频率受限,请稍后访问 |
| 412 | 大图片请求过于频繁，请稍后访问 |
| 29001 | inputType 类型不对 |
| 29002 | needTypo 类型不对 |
| 29003 | Q 超过限制长度 |
| 29004 | grade 类型不对 |
| 29005 | 文件为空 |
| 29006 | 图片过大 |
| 29007 | 作文批改的文本内容为空 |
| 29100 | 作文指导底层异常 |
| 29101 | 作文指导 requirement 长度超出限制 |
| 29102 | 作文指导 requirement 语种不是中文 |
| 29103 | 作文指导 requirement 含敏感词 |
| 29301 | 作文批改识别失败 |
| 29302 | 作文批改请求失败 |
返回结果参数
| 参数名称 | 描述 |
|---|---|
| RequestId | 请求Id |
| errorCode | 错误码 |
| msg | 错误信息 |
| data | 指导结果（详见data项） |
data内容：
| 名称 | 类型 | 描述 |
|---|---|---|
| failedTypes | List of Integer | 没有结果的指导项 |
| guidance | Guidance | 指导意见（详见guidance项） |
guidance内容：
| 名称 | 类型 | 描述 |
|---|---|---|
| analysis | Integer | 题目解析 |
| corePoint | Integer | 核心观点 |
| material | String | 素材参考 |
| paraAlloc | String | 段落分配 |
failedTypes 取值说明：
| 取值 | 取值说明 |
|---|---|
| 1 | 题⽬解析 |
| 2 | 素材参考 |
| 3 | 核⼼观点 |
| 4 | 段落分配 |