产品文档-智慧学习服务

文本润色 API 简介

说明

Hi，您好，欢迎使用有道智云文本润色API接口服务。

本文档主要针对需要集成HTTP API的技术开发工程师，详细描述文本润色能力相关的技术内容。

如果您有与我们商务合作的需求，可以通过以下方式联系我们：

商务邮箱： AIcloud_Business@corp.youdao.com

如果您对文档内容有任何疑问，可以通过以下几种方式联系我们：

客服QQ：1906538062

智云翻译技术交流QQ 1群: 652880659

智云翻译技术交流QQ 2群: 669384425

智云翻译技术交流QQ 3群: 807539209

智云翻译技术交流QQ 4群: 936752411

联系邮箱： zhiyun@corp.youdao.com

温馨提示：

本文档主要针对开发人员，接入测试前需要获取 应用ID 和 应用密钥；如果您还没有，请按照新手指南获取。
平台向每个账户赠送50元的体验金，供用户集成前测试所用，具体资费规则详见文本润色服务报价。

接口说明

文本润色API接口是有道 AI 团队自研的基于深度学习网络技术的文本润色技术。覆盖学生学习全周期，提供高参考价值的智能润色功能，用户只需要输入一段英文，智能文本润色服务即可把文本分成句子，按句给出润色结果，并给出润色后句子与原句子之间的差异对比。

文本润色API HTTPS地址：

https://openapi.youdao.com/v2/polish

协议须知

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

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

接口调用参数

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

字段名	类型	含义	必填
appKey	应用标识（应用 ID）	在应用管理查看	true
curtime	当前UTC时间戳(秒)	时间戳	true
title	润色文本标题	标识润色文本，0<标题长度<100	false
rawEssay	润色文本	仅支持英文，30 ≤ 文本长度 ≤10000，有效单词数 ≥ 3	true
salt	随机字符串	可以使用uuid作为唯一标识符	true
sign	签名信息	sha256(应用ID+input+salt+curtime+应用密钥)	true
signType	签名类型	v3	true

注意： 待润色文本不能为空，长度必须小于等于10000，有效单词数需大于等于3（空格分割单词）

签名生成方法如下：
signType=v3；
sign=sha256(应用ID+input+salt+curtime+应用密钥)；
其中，input的计算方式为：input=rawEssay前10个字符 + rawEssay长度 + rawEssay后10个字符（当rawEssay长度大于20）或 input=rawEssay字符串（当rawEssay长度小于等于20）；

注意：

接口salt+curtime来防重放（即一个请求不可以被请求2次），所以salt最好为UUID。

不同语言获取时间戳，请参看此链接

如果对签名有疑问，可以参看各语言demo。

输出结果

返回结果参数

参数名称	描述
requestId	请求Id
code	处理状态码
msg	报错信息
data	数据结果

data 内容：

名称	类型	描述
sentNum	Integer	句子数量
title	String	文章标题
essayLangName	String	文章语言
sentList	List of SentParaphraseVO	润色结果列表

SentParaphraseVO 内容：

名称	类型	描述
index	Integer	句子索引
code	Integer	单句子返回结果状态码
msg	String	单句子返回结果状态信息
rawSent	String	润色前原始句子
sentList	List of SentDiffVO	润色后句子列表

SentDiffVO 内容：

名称	类型	描述
ParaphrasedSent	String	润色后的句子
diff	List of Diff	润色后句子与原句子之间的差异对比

Diff 内容：

名称	类型	描述
operation	String	差异类型：INSERT, DELETE or EQUAL
text	String	差异文本片段

SentParaphraseVO code 字段取值说明

取值	取值说明
0	有润色结果
1010	无润色结果：句子过长无法润色
1011	无润色结果：算法模型未返回结果

Diff operation 字段取值说明：润色前原始句子，经过Diff列表的顺序操作后，可转成润色后的句子

取值	取值说明
DELETE	润色前原始句子，删除此text片段，可转成润色后的句子
INSERT	润色前原始句子，新增此text片段，可转成润色后的句子
EQUAL	润色前原始句子，保留此text片段，可转成润色后的句子

服务配置

润色文本单次字符数	润色标题字符数
长度必须小于等于10000，有效单词数需大于等于3（空格分割单词）	0<标题长度<100

错误代码列表

错误码	含义
101	缺少必填的参数,首先确保必填参数齐全，然后确认参数书写是否正确。
102	不支持的语言类型
103	翻译文本过长
104	不支持的API类型
105	不支持的签名类型
106	不支持的响应类型
107	不支持的传输加密类型
108	应用ID无效，注册账号，登录后台创建应用并完成绑定，可获得应用ID和应用密钥等信息
109	batchLog格式不正确
110	无相关服务的有效应用,应用没有绑定服务应用，可以新建服务应用。注：某些服务的翻译结果发音需要tts服务，需要在控制台创建语音合成服务绑定应用后方能使用。
111	开发者账号无效
112	请求服务无效
113	q不能为空
114	不支持的图片传输方式
116	strict字段取值无效，请参考文档填写正确参数值
199	鉴权时发生错误
201	解密失败，可能为DES,BASE64,URLDecode的错误
202	签名检验失败,如果确认应用ID和应用密钥的正确性，仍返回202，一般是编码问题。请确保翻译文本 `q` 为UTF-8编码.
203	访问IP地址不在可访问IP列表
205	请求的接口与应用的平台类型不一致，确保接入方式（Android SDK、IOS SDK、API）与创建的应用平台类型一致。如有疑问请参考入门指南
206	因为时间戳无效导致签名校验失败, 当前UTC时间戳(秒).
207	重放请求,接口salt+curtime来防重放（即一个请求不可以被请求2次），所以salt最好为UUID
301	辞典查询失败
302	翻译查询失败
303	服务端的其它异常
304	会话闲置太久超时
401	账户已经欠费，请进行账户充值
402	offlinesdk不可用
405	鉴权失败
500	翻译失败，请参考errorMessage
411	访问频率受限,请稍后访问
412	长请求过于频繁，请稍后访问
1001	润色文本为空
1002	单句话超长错误(润色文本少于3个词)
1003	参数为空或参数非法
1004	语种非法，请参考语种列表
1005	章长度限制(30<润色文本字符数<10000)

常用语言demo

Java 示例

文本润色 Java demo