自动标点API服务文档

API服务申请流程:用户在本网站注册账号—>通过“账户设置”申请VIP用户,填写详细信息—>系统审核通过—>用户即可在"账户设置"页面,获取“授权API ID”。申请前,请先仔细阅读本文档。

一、接口描述

基于人工智能(AI)技术,通过机器实现给无标点的古汉语文本自动标注现代中文标点。API服务有效期限系统默认为30天,需每30天进行定期更换,手动获取新的“API ID”即可(在"账户设置"页面操作)。如果您对文档内容有任何疑问,请联系技术支持人员。

二、请求说明

请求示例

HTTP 方法:POST

请求URL:http://gj.cool/gjcool/index/httpAPI

URL参数:

参数
client_id 用于标识用户的ID。用户需注册账号后,申请VIP用户,待系统审核通过后,可在"账户设置"页面,点击获取“授权API ID”即可。
client_secret 用于认证的密钥。该值获取方式同上。

完整的URL请求:http://gj.cool/gjcool/index/httpAPI?client_id=xxx&client_secret=xxx

Header声明如下:

参数
Content-Typeapplication/json;charset=UTF-8

Body请求示例:

[{"src":"夫戒德難思冠超眾象為五乘之軌導寔三寶之舟航依教建修定慧之功莫等住持佛法群籍於茲息唱"}]
[{"src":"夫戒德難思冠超眾象為五乘之軌導寔三寶之舟航"},‥‥‥,{"src":"欲明揚顯行儀匡攝像教垂彝範訓末學紐既絕之玄綱樹已顛之大表者可得詳而評之"}]

Body中放置请求参数,参数详情如下:

参数是否必选类型可选值范围说明
src string- 整个JSON字符串可以只含一个src元素,也可包含多个src元素(逗号间隔开)。其中每个src元素代表一个段落,当src为空值时特指一个段落空行。

三、返回说明

若请求成功,服务器返回的JSON文本将包含以下参数:

返回参数

字段是否必选类型说明
pred array(object) 对应自动标点后的文本字符集合
orig array(object) 对应原始文本字符集合
list array(object) 存放无标点标志(无标点时自动标点引擎返回空值“”)和现代标点符号的集合
probs array(object) 置信度,范围:0~10000(单位:万分比)。即依次在每个原始文本字符后面,无标点标志和现代标点符号各自出现的概率值集合。每组概率值中概率最大的值对应的标点,即为自动标点引擎在文本中标注的标点。最后一组概率值不对应任何原始文本字符,表示标点文本结束。

返回示例


HTTP/1.1 200 
Pragma: no-cache
Cache-Control: no-cache
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Thu, 08 Nov 2018 12:34:01 GMT
[{
	"pred": ["夫", "戒", "德", "難", "思", ",", "冠", "超", "眾", "象", ",", "為", "五", "乘", "之", "軌", "導", ",", "寔", "三", "寶", "之", "舟", "航", "。"],
	"orig": ["夫", "戒", "德", "難", "思", "冠", "超", "眾", "象", "為", "五", "乘", "之", "軌", "導", "寔", "三", "寶", "之", "舟", "航"],
	"list": ["", ",", "。", "、", ":", "?", ";", "!"],
	"probs": [
		["9945", "38", "9", "0", "0", "0", "0", "4"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9998", "1", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["457", "9269", "223", "44", "1", "0", "3", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["26", "7720", "1999", "2", "8", "0", "240", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["72", "8850", "795", "271", "0", "0", "7", "1"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["0", "20", "9962", "0", "0", "3", "2", "9"],
		["0", "0", "0", "0", "0", "0", "0", "0"]
	]
}, {
	"pred": ["依", "教", "建", "修", ",", "定", "慧", "之", "功", ",", "莫", "等", "住", "持", "佛", "法", "群", "籍", ",", "於", "茲", "息", "唱", "。"],
	"orig": ["依", "教", "建", "修", "定", "慧", "之", "功", "莫", "等", "住", "持", "佛", "法", "群", "籍", "於", "茲", "息", "唱"],
	"list": ["", ",", "。", "、", ":", "?", ";", "!"],
	"probs": [
		["9991", "1", "0", "5", "0", "0", "0", "0"],
		["9937", "44", "3", "14", "0", "0", "0", "0"],
		["9986", "11", "0", "1", "0", "0", "0", "0"],
		["1560", "7395", "896", "33", "88", "2", "21", "1"],
		["9662", "2", "0", "334", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["819", "8983", "130", "3", "3", "0", "59", "0"],
		["9975", "17", "3", "0", "0", "0", "2", "0"],
		["9840", "71", "30", "3", "0", "0", "53", "0"],
		["9987", "3", "1", "4", "0", "0", "1", "0"],
		["3759", "3547", "2250", "47", "3", "1", "386", "3"],
		["9998", "0", "0", "0", "0", "0", "0", "0"],
		["9420", "539", "21", "16", "0", "0", "2", "0"],
		["9997", "2", "0", "0", "0", "0", "0", "0"],
		["913", "8954", "120", "9", "0", "0", "2", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["9999", "0", "0", "0", "0", "0", "0", "0"],
		["0", "26", "9874", "0", "9", "0", "10", "77"],
		["0", "0", "0", "0", "0", "0", "0", "0"]
	]
}]

错误码说明

错误码错误信息描述
110 certification failed 身份认证失败,请检查client_id和client_secret参数后重新尝试。
111 api expired api服务过期,请重新获取API ID。
112internal error 服务器内部错误,请再次请求, 如果持续出现此类错误,请联系技术支持人员。
113invalid param请求中包含非法参数,请检查后重新尝试
114not enough param缺少必须的参数,请检查参数是否有遗漏
115missing parameters: {参数名} 请求参数缺失
116empty original text原始文本为空,请检查后重新尝试
117original text characters  limit reached 原始文本字数(含所有字符)超出限制,例如单次请求不能大于2万字。