帮助与文档 > 产品文档 > 智慧学习服务 > 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_guide_text  

协议须知

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

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

接口调用参数

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

字段名含义备注必填
appKey应用标识(应用 ID)控制台创建应用获取true
curtime当前UTC时间戳(秒)时间戳true
salt随机字符串1658393284erwtrue
sign签名信息:sha256(appKey+input+salt+密钥)sha256(appKey+input+salt+密钥)true
signType签名类型v3true
requirement题目要求长度[4 - 300]true

服务配置

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

错误代码列表

错误码含义
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作文批改的文本内容为空
29100作文指导底层服务异常
29101作文指导 requirement 长度超出限制
29102作文指导 requirement 语种不是中文
29103不合时宜词汇
29301作文批改识别失败
29302作文批改请求失败

返回结果参数

参数名称描述
RequestId请求Id
errorCode错误码
msg错误信息
data指导结果(详见data项)
data内容:
名称类型描述
failedTypesList of Integer没有结果的指导项
guidanceGuidance指导意见(详见guidance项)
guidance内容:
名称类型描述
analysisInteger题目解析
corePointInteger核心观点
materialString素材参考
paraAllocString段落分配
failedTypes 取值说明:
取值取值说明
1题⽬解析
2素材参考
3核⼼观点
4段落分配