帮助与文档 > 产品文档 > 智慧学习服务 > API文档 > 中文作文批改(文本输入)
中文作文批改(文本输入)

中文作文批改(文本输入) 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_text  

协议须知

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

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

接口调用参数

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

字段名含义备注必填
appKey应用标识(应用 ID)控制台创建应用获取true
curtime当前UTC时间戳(秒)时间戳true
q正文文本支持中文,长度<=1200true
salt随机字符串1658393284erwtrue
sign签名信息:sha256(appKey+input+salt+密钥+curtime)sha256(appKey+input+salt+密钥)true
signType签名类型v3true
grade作文等级对应k12等级(详见注意)false
title作文标题长度<=30false
requirement题目要求长度<=200false
  • 注意:grade 级别为 K12,参数从 g1、g2、...、g12,默认g1

服务配置

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

错误代码列表

错误码含义
101缺少必填的参数,首先确保必填参数齐全,然后,确认参数书写是否正确。
102不支持的语言类型
103翻译文本过长
104不支持的 API 类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108appKey 无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用 ID 和密钥等信息,其中应用 ID 就是 appKey( 注意不是应用密钥)
109batchLog 格式不正确
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大图片请求过于频繁,请稍后访问
29001inputType 类型不对
29002needTypo 类型不对
29003Q 超过限制长度
29004grade 类型不对
29005文件为空
29006图片过大
29007作文批改的文本内容为空
29301作文批改识别失败
29302作文批改请求失败

返回结果参数

参数名称描述
RequestId请求Id
errorCode错误码
Result返回结果(详见result项)
Result内容:
名称类型描述
orgContentString原始的作文内容
correctedContentList of CorrectedSentcontent 详细的纠正信息(详见CorrectedSent项)
scoreCollectionScoreCollection所有的评分信息(详见ScoreCollection项)
commentCollectionCommentCollection所有的评价信息(详见commentCollection项)
detailedEvaluationDetailedEvaluation从句子、词语角度给出详细的评价(详见detailedEvaluation项)
CorrectedSent内容:
名称类型描述
paraIdInteger段落ID
sentIdInteger句子ID
orgSentString原始句子
corSentString修正后的句子
orgSentStartInteger原始句子的起始位置(相对于请求中的 content、包含了空格空行等)
errorInfosList of ErrorInfo针对当前句子的错误信息(详见ErrorInfo项)
ErrorInfo内容:
名称类型描述
orgChunkString原始片段
corChunkString正确片段
orgChunkStartInteger原始片段的起始位置(相对于 orgSent、包含了空格等)
errorTypeString错误类型,可选项见ErrorType可选项
ErrorType可选项
ErrorType可选项名称解释
spell拼写错误拼写错误包括了同音字错误等
space空格错误与空格相关的各种错误
punct标点错误与标点符号相关的各种错误
grammar语法错误上述错误之外的错误,会被划分为语法错误
CommentCollection
名称类型描述
commentString整体评价
detailedEvaluation
名称类型描述
sentenceEvaluationList of SentenceEvaluation针对句子的评价,比如是不是好句子
phraseEvalutionList of PhraseEvaluation针对词语的评价,比如成语
SentenceEvaluation (位置信息是左闭右开的区间)
名称类型描述
typeString目前有可选项“good”,用来表明是好句子
startInteger句子的起始位置(相对于请求中的 content)(unicode)
endInteger句子的结束位置(相对于请求中的 content)(unicode)
PhraseEvaluation (位置信息是左闭右开的区间)
名称类型描述
typeString目前有可选项“idiom”,用来表明是成语
startInteger句子的起始位置(相对于请求中的 content)(unicode)
endInteger句子的结束位置(相对于请求中的 content)(unicode)
explanationString成语解释,当 type==“idiom”的时候,这个字段有效
ScoreCollection内容:
名称类型限制条件描述
scoreInteger0<=score<=100整体得分
perspectiveScorePerspectiveScore见下面的 PerspectiveScore从不同的角度,对作文进行打分
PerspectiveScore(详见评分规则)
名称类型限制条件描述
themeExplicitInteger0<=分数<=5主题明确,需要传入requirement,title才是有效分数
satisfyRequirementInteger0<=分数<=5符合题意 ,需要传入requirement才是有效分数
sentimentSincerityInteger0<=分数<=5感情真挚
structureStrictInteger0<=分数<=5结构严谨
essayFluenceInteger0<=分数<=5语言流畅
goodSentInteger0<=分数<=5好词好句
评分规则
评价的方面得分或者限制对应的评语
satisfyRequirement0
satisfyRequirement1对题意的理解不够充分,有偏题的嫌疑。
satisfyRequirement2能理解题目要求,文章基本符合题意。
satisfyRequirement3能较好地把握题目要求,文章符合题意。
satisfyRequirement4能正确理解题目要求,文章符合题意。
satisfyRequirement5能准确理解题目要求,文章切合题意。
themeExplicit0中心不够明确,立意不够清晰。
themeExplicit1中心不够明确,立意不够清晰。
themeExplicit2虽有中心主题,但表达不够充分有力,文章略显空洞。
themeExplicit3主题基本明确。
themeExplicit4主题较明确。
themeExplicit5主题明确,立意鲜明。
goodSent0
goodSent1用词过于平淡,缺乏文采。
goodSent2偶尔使用好词好句,语言平淡质朴。
goodSent3能够适当运用好词好句,语言生动活泼。
goodSent4遣词造句优美,文章富有文采。
goodSent5本文语言极其优美,文章极富文学气息。
sentimentSincerity0感受不深刻,缺乏感染力。
sentimentSincerity1情感缺乏深度。
sentimentSincerity2语言简朴,感情平淡,情意不够深切。
sentimentSincerity3感情真实,发自肺腑。
sentimentSincerity4情感饱满,情真意切,能深深打动读者。
sentimentSincerity5感情真挚动人,情感丰沛,极富感染力。
structureStrict0条理不清,结构混乱。
structureStrict1层次不清,结构较乱。
structureStrict2层次欠清楚,结构较合理。
structureStrict3层次较分明,结构完整。
structureStrict4层次清晰,结构完整。
structureStrict5层次清晰,结构严谨。
essayFluence0语句不通顺,表述不清晰,令人费解。
essayFluence1语句欠通,缺乏连贯性。
essayFluence2语句基本通顺,偶有不畅。
essayFluence3语句通顺流畅。
essayFluence4语句流畅连贯,自然通达。
essayFluence5语言平滑晓畅,可读性强。
比喻手法> 3比喻生动形象贴切,本体与喻体形神相似,文章的趣味性与说服力都大大增强了。
排比手法> 2运用排比的手法,既增强语势,又给读者留下了十分深刻的印象。
其他words < 20 or paragraphs < 2您输入的作文句子、段落数量较少。
  • 当有额外的比喻手法排比手法出现的时候,会用此外,进行衔接
  • 当符合其他的情况的时候,会直接返回对应的评语

常用语言 Demo

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