中文作文批改（文本输入-高级版）-中文作文批改（文本输入-高级版）API文档-有道智云AI开放平台

中文作文批改（文本输入-高级版） 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/v2/correct_writing_cn_text

协议须知

调用方在集成文本翻译 API 时，请遵循以下规则。

规则	描述
传输方式	HTTPS
请求方式	POST
字符编码	统一使用 UTF-8 编码
请求格式	表单
响应格式	JSON

接口调用参数

调用 API 需要向接口发送以下字段来访问服务。

字段名	含义	备注	必填
appKey	应用标识（应用 ID）	控制台创建应用获取	true
curtime	当前UTC时间戳(秒)	时间戳	true
q	正文文本	支持中文，长度<=1200	true
salt	随机字符串	1658393284erw	true
sign	签名信息：sha256(appKey+input+salt+密钥)	sha256(appKey+input+salt+密钥)	true
signType	签名类型	v3	true
grade	作文等级	对应k12等级（详见注意）	false
title	作文标题	长度<=30	false
requirement	题目要求	长度<=200	false

注意：grade 级别为 K12，参数从 g1、g2、...、g12，默认g1

服务配置

服务内容	说明
文本输入	最大支持 1200字符

错误代码列表

错误码	含义
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	含不合时宜词汇
29301	作文批改识别失败
29302	作文批改请求失败

返回结果参数

参数名称	描述
RequestId	请求Id
errorCode	错误码
Result	返回结果（详见result项）

Result内容：

名称	类型	描述
orgContent	String	原始的作文内容
correctedContent	List of CorrectedSent	content 详细的纠正信息（详见CorrectedSent项）
scoreCollection	ScoreCollection	所有的评分信息（详见ScoreCollection项）
commentCollection	CommentCollection	所有的评价信息（详见commentCollection项）
detailedEvaluation	DetailedEvaluation	从句子、词语角度给出详细的评价（详见detailedEvaluation项）
uniqueKey	String	文章id （暂无具体使用）
version	String	文章的版本号（保留字段，无具体使用）

CorrectedSent内容：

名称	类型	描述
paraId	Integer	段落ID
sentId	Integer	句子ID
orgSent	String	原始句子
corSent	String	修正后的句子
orgSentStart	Integer	原始句子的起始位置（相对于请求中的 content、包含了空格空行等）
errorInfos	List of ErrorInfo	针对当前句子的错误信息（详见ErrorInfo项）

ErrorInfo内容：

名称	类型	描述
orgChunk	String	原始片段
corChunk	String	正确片段
orgChunkStart	Integer	原始片段的起始位置（相对于 orgSent、包含了空格等）
errorType	String	错误类型，可选项见ErrorType可选项

ErrorType可选项

ErrorType可选项	名称	解释
spell	拼写错误	拼写错误包括了同音字错误等
space	空格错误	与空格相关的各种错误
punct	标点错误	与标点符号相关的各种错误
grammar	语法错误	上述错误之外的错误，会被划分为语法错误

CommentCollection

名称	类型	描述
comment	String	整体评价
rating	String	作文评级
style	String	作文体裁
titleConflict	String	标题与正文是否一致
expectTitle	String	推荐的标题
aspectComment	AspectComment	改进建议

aspectComment 内容

名称	类型	描述
langExpression	String	改进建议
structLogic	String	结构逻辑
contentInfo	String	内容深度
emotion	String	情感丰富度

rating作文评级取值说明

取值	取值说明
1	亟需努力
2	中等
3	良好
4	较为优秀
5	优秀

detailedEvaluation

名称	类型	描述
sentenceEvaluation	List of SentenceEvaluation	针对句子的评价，比如是不是好句子
phraseEvalution	List of PhraseEvaluation	针对词语的评价，比如成语

SentenceEvaluation （位置信息是左闭右开的区间）

名称	类型	描述
type	String	目前有可选项“good”，用来表明是好句子
start	Integer	句子的起始位置（相对于请求中的 content）(unicode)
end	Integer	句子的结束位置（相对于请求中的 content）(unicode)
comment	String	句子评价

PhraseEvaluation （位置信息是左闭右开的区间）

名称	类型	描述
type	String	目前有可选项“idiom”，用来表明是成语
start	Integer	句子的起始位置（相对于请求中的 content）(unicode)
end	Integer	句子的结束位置（相对于请求中的 content）(unicode)
explanation	String	成语解释，当 type==“idiom”的时候，这个字段有效

ScoreCollection内容：

名称	类型	限制条件	描述
score	Integer	0<=score<=100	整体得分
perspectiveScore	PerspectiveScore	见下面的 PerspectiveScore	从不同的角度，对作文进行打分

PerspectiveScore（详见评分规则）

名称	类型	限制条件	描述
themeExplicit	Integer	0<=分数<=5	主题明确，需要传入requirement，title才是有效分数
satisfyRequirement	Integer	0<=分数<=5	符合题意，需要传入requirement才是有效分数
sentimentSincerity	Integer	0<=分数<=5	感情真挚
structureStrict	Integer	0<=分数<=5	结构严谨
essayFluence	Integer	0<=分数<=5	语言流畅
goodSent	Integer	0<=分数<=5	好词好句

评分规则

评价的方面	得分或者限制	对应的评语
satisfyRequirement	0
satisfyRequirement	1	对题意的理解不够充分，有偏题的嫌疑。
satisfyRequirement	2	能理解题目要求，文章基本符合题意。
satisfyRequirement	3	能较好地把握题目要求，文章符合题意。
satisfyRequirement	4	能正确理解题目要求，文章符合题意。
satisfyRequirement	5	能准确理解题目要求，文章切合题意。
themeExplicit	0	中心不够明确，立意不够清晰。
themeExplicit	1	中心不够明确，立意不够清晰。
themeExplicit	2	虽有中心主题，但表达不够充分有力，文章略显空洞。
themeExplicit	3	主题基本明确。
themeExplicit	4	主题较明确。
themeExplicit	5	主题明确，立意鲜明。
goodSent	0
goodSent	1	用词过于平淡，缺乏文采。
goodSent	2	偶尔使用好词好句，语言平淡质朴。
goodSent	3	能够适当运用好词好句，语言生动活泼。
goodSent	4	遣词造句优美，文章富有文采。
goodSent	5	本文语言极其优美，文章极富文学气息。
sentimentSincerity	0	感受不深刻，缺乏感染力。
sentimentSincerity	1	情感缺乏深度。
sentimentSincerity	2	语言简朴，感情平淡，情意不够深切。
sentimentSincerity	3	感情真实，发自肺腑。
sentimentSincerity	4	情感饱满，情真意切，能深深打动读者。
sentimentSincerity	5	感情真挚动人，情感丰沛，极富感染力。
structureStrict	0	条理不清，结构混乱。
structureStrict	1	层次不清，结构较乱。
structureStrict	2	层次欠清楚，结构较合理。
structureStrict	3	层次较分明，结构完整。
structureStrict	4	层次清晰，结构完整。
structureStrict	5	层次清晰，结构严谨。
essayFluence	0	语句不通顺，表述不清晰，令人费解。
essayFluence	1	语句欠通，缺乏连贯性。
essayFluence	2	语句基本通顺，偶有不畅。
essayFluence	3	语句通顺流畅。
essayFluence	4	语句流畅连贯，自然通达。
essayFluence	5	语言平滑晓畅，可读性强。
比喻手法	> 3	比喻生动形象贴切，本体与喻体形神相似，文章的趣味性与说服力都大大增强了。
排比手法	> 2	运用排比的手法，既增强语势，又给读者留下了十分深刻的印象。
其他	words < 20 or paragraphs < 2	您输入的作文句子、段落数量较少。

当有额外的比喻手法、排比手法出现的时候，会用此外，进行衔接
当符合其他的情况的时候，会直接返回对应的评语

常用语言 Demo

请参考英文作文批改服务示例demo