1、科大讯飞语音云使用说明API参数集用户通过指定API参数来获取对应的结果，语言云服务的API参数集如下表所示：参数名含义说明api_key用户注册语音云服务后获得的认证标识text待分析的文本请以UTF-8格式编码，GET方式最大10K，POST方式最大20Kpattern用以指定分析模式，可选值包括ws(分词)，pos(词性标注)，ner(命名实体识别)，dp(依存句法分析)，srl(语义角色标注),all(全部任务)plain格式中不允许指定全部任务format用以指定结果格式类型，可选值包括xml(XML格式)，json(JSON格式)，conll(CONLL格式)，plain(简洁文本
2、格式)xml_input用以指定输入text是否是xml格式，可选值为false(默认值),true仅限POST方式has_key用以指定json结果中是否含有键值，可选值包括true(含有键值，默认)，false(不含有键值)配合format=json使用only_ner用以指定plain格式中是否只需要ner列表，可选值包括false(默认值)和true配合pattern=ner&format=plain使用callback用以指定JavaScript调用中所使用的回调函数名称配合format=json使用*调用方式用户可以用两种方式来调用API，直接使用REST|在JavaScript中
3、使用RESTRESTREST,或者叫做Representational State Transfer，在语言云API中并不等同于传统的REST。传统的REST提供对于资源的访问，而语言云REST API提供对于服务的访问。因此，在语言云API中，一个单独的URI就是一个服务端点。在语言云中，所有的API访问都是通过HTTP请求的方式。并且需要从域进行访问。语言云只支持GET和POST方式的HTTP请求。用户通过在HTTP请求中指定参数来获取对应的结果。举个例子，对“我是中国人。”这句话做依存句法分析，并且返回plain格式的结果。GET请求及返回结果示例：$ curl -iHTTP/1.1 2
4、00 OKServer: nginx/1.1.19Date: Fri, 03 Jan 2014 04:24:32 GMTContent-Type: text/plainTransfer-Encoding: chunkedConnection: keep-aliveVary: Accept-Encoding是_1-1HED中国_2人_3 ATT人_3是_1 VOBPOST请求及返回结果示例：$ curl -i -dapi_key=YourApiKey&text=我是中国人。&pattern=dp&format=plain HTTP/1.1 200 OKServer: nginx/1.1.19Da
5、te: Fri, 03 Jan 2014 05:58:55 GMTContent-Type: text/plainTransfer-Encoding: chunkedConnection: keep-aliveVary: Accept-Encoding我_0是_1 SBV是_1-1HED中国_2人_3 ATT人_3是_1 VOB使用Python语言以GET方式调用REST API代码示例如下：1.# -*- coding:utf8 -*-2.import urllib23.if _name_ =_main_:4.url_get_base =5.api_key =6.text =7.format
6、 =8.pattern =9.result = urllib2.urlopen(%sapi_key=%s&text=%s&format=%s&pattern=%s% (url_get_base,api_key,text,format,pattern)10.content = result.read().strip()11.print content更多使用其他编程语言以GET和POST方式调用REST API代码示例以及注意事项请参考API编程调用示例。JavaScript调用REST语言云支持用户使用JavaScript以JSON-P回调的方式调用API，用户需要以GET方式进行调用并且只支
7、持json的返回格式。在此方式中，需要用户在uri中添加callback参数并且在js中指定相同名称的回调函数进行结果的捕捉，这通常用于跨域访问使得结果嵌入到Web页面中。$ curl -iHTTP/1.1 200 OKServer: nginx/1.1.19Date: Fri, 03 Jan 2014 08:08:56 GMTContent-Type: application/javascriptTransfer-Encoding: chunkedConnection: keep-aliveVary: Accept-Encodingfoo(/json data)在JavaScript中捕捉调
8、用结果代码示例如下：1.var foo = function(data)2.json_str = JSON.stringify(data);3.document.getElementsByTagName(body)0.innerHTML += json_str;4.;5.window.onload=function()6.var base =7.var api_key =;8.var text =;9.var pattern =;10.var format =json;11.var callback =foo;12.var url = base +api_key=+api_key+&text=
9、+text+&pattern=+pattern+&format=+format+&callback=+callback;13.var script = document.createElement(script);14.script.setAttribute(src, url);15.document.getElementsByTagName(head)0.appendChild(script);16.语言云也提供了使用Jquery调用API的示例，请参考JavaScript调用API示例。*结果表示PLAIN分词对文本进行分词的调用示例如下：GET 返回结果为：1.我是中国人。在plain格
10、式的分词结果中，每句话占一行。词与词之间用空格分割，句与句之间用换行分割。段落与段落之间用两个换行分割。词性标注对文本进行词性标注的调用示例如下：GET 返回结果为：1.我_r是_v中国_ns人_n。_wp在plain格式的词性标注结果中，每句话占一行。词和词的标注信息之间用下划线连接，项与项之间用空格分割，句与句之间用换行分割。段落与段落之间用两个换行分割。命名实体识别对文本进行命名实体识别的调用示例如下：GET 返回结果为：1.我是中国Ns人。在plain格式的命名实体识别结果中，每句话占一行。如果本句话含有实体，将会被包围，并且在之后添加实体类型标识。段落与段落之间有两个换行符分割。如果
11、您只想获得文本中的所有的命名实体列表，请用参数only_ner=true来指定。其调用示例如下：GET 返回结果为：1.中国Ns在plain格式的命名实体识别列表形式的返回结果中，每个实体信息占一行。每一行有两列，第一列为实体本身，第二列为实体类型。依存句法分析对文本进行依存句法分析的调用示例如下：GET 返回结果为：1.我_0是_1SBV2.是_1-1HED3.中国_2人_3ATT4.人_3是_1VOB5.。_4是_1WP在plain格式的依存句法分析返回结果中，文本中的每个词的句法信息占一行。每一行独占三列。第一列为依存句法分析的孩子结点信息，由结点名+下划线+词id组成；第二列为依存句法
12、分析的父亲节点信息，由结点名+下划线+词id组成，如果没有父亲结点，则由-1表示;第三列为具体的依存句法分析关系。文本句子级别的信息之间用两个换行分割，文本段落级别的信息之间用三个换行分割。语义角色标注对文本进行语义角色标注的调用示例如下：GET 返回结果为：1.我A0是v中国人A1。XML对文本进行全部任务的分析示例如下：GET 返回结果为：1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.16.17.18.XML标准结果如下：结点标签分别为xml4nlp,note,doc,para,sent,word,arg共七种结点标签：1.xml4nlp为根结点，无任何属性值；2
13、.note为标记结点，具有的属性分别为：sent,word,pos,ne,parser,srl；分别代表分句，分词，词性标注，命名实体识别，依存句法分析，词义消歧，语义角色标注；值为n，表明未做，值为y则表示完成，如pos=y，表示已经完成了词性标注；3.doc为篇章结点，以段落为单位包含文本内容；无任何属性值；4.para为段落结点，需含id 属性，其值从0 开始；5.sent为句子结点，需含属性为id，cont；id 为段落中句子序号，其值从0 开始；cont 为句子内容；6.word为分词结点，需含属性为id, cont；id 为句子中的词的序号，其值从0 开始，cont为分词内容；可选
14、属性为pos,ne,parent,relate；pos的内容为词性标注内容；ne为命名实体内容；parent与relate成对出现，parent为依存句法分析的父亲结点id 号，relate为相对应的关系；7.arg为语义角色信息结点，任何一个谓词都会带有若干个该结点；其属性为id,type,beg，end；id为序号，从0 开始；type代表角色名称；beg为开始的词序号，end为结束的序号；各结点及属性的逻辑关系说明如下：1. 各结点层次关系可以从图中清楚获得，凡带有id 属性的结点是可以包含多个；2. 如果sent=n即未完成分句，则不应包含sent 及其下结点；3. 如果sent=y
15、word=n即完成分句，未完成分词，则不应包含word 及其下结点；4. 其它情况均是在sent=y word=y的情况下：(1) 如果pos=y则分词结点中必须包含pos 属性；(2) 如果ne=y则分词结点中必须包含ne 属性；(3) 如果parser=y则分词结点中必须包含parent 及relate 属性；(4) 如果srl=y则凡是谓词(predicate)的分词会包含若干个arg 结点；在XML格式的分析中，用户可以通过指定参数pattern=ws | pos | ner | dp | srl | all 来指名分析任务并获取对应的XML结果。注意！ 依存句法分析结果中并不具有ne
16、信息。JSON对文本进行全部任务的分析示例如下：GET 返回结果为：id: 0,cont:我,pos:r,ne:O,parent: 1,relate:SBV,arg: ,id: 1,cont:是,pos:v,ne:O,parent: -1,relate:HED,arg: id: 0,type:A0,beg: 0,end: 0,id: 1,type:A1,beg: 2,end: 3,id: 2,cont:中国,pos:ns,ne:S-Ns,parent: 3,relate:ATT,arg: ,id: 3,cont:人,pos:n,ne:O,parent: 1,relate:VOB,arg: ,J
17、SON (JavaScript Object Notation) 是一种常见的，与语言无关的数据格式，提供任意数据结构的简单表示。在json格式的返回结果中，采用段落级、句子级、单词级的递进层次关系，且段落与句子并没有进行键值名标识，因而须采用数组下标方式获取信息。比如说，p代表json结果，获取第一段第二句第三个单词的词性信息，获取方式类似于p012pos。json格式是语言云重点推荐给用户的语言分析结果格式，有关更多使用方法，请参考语言云提供的JSON格式的重要说明。在json格式的单词对象中，需含键值名为id, cont；id 为句子中的词的序号，其值从0 开始，cont为分词内容；可选
18、键值名为 pos, ne, parent, relate；pos 的内容为词性标注内容；ne 为命名实体内容；parent 与 relate 成对出现，parent 为依存句法分析的父亲结点id 号，relate 为相对应的关系；如果用户做了srl级别的分析，json结果中还会有键值名arg所标识的数组。数组中的每个对象是一项语义角色，任何一个谓词都会带有若干个该对象；其键值名为id, type, beg，end；id 为序号，从0 开始；type 代表角色名称；beg 为开始的词序号，end 为结束的序号；如果单词没有语义角色信息，arg所标识的数组为空。用户也可以通过指定参数has_key
19、=false来去掉键值名，示例如下：GET 返回结果为： 0,我,r,O, 1,SBV, , 1,是,v,O, -1,HED, 0,A0, 0, 0 , 1,A1, 2, 3 , 2,中国,ns,S-Ns, 3,ATT, , 3,人,n,O, 1,VOB, 在json格式的无键值名的返回结果中，数组信息排序与有键值名的情况相同。即按照：id,cont,pos,ne,parent,relate,arg的顺序。arg中信息的顺序为id,type,beg,end。CONLL对文本进行全部任务的分析示例如下：GET 返回结果为：1.0我_rO1SBV_(A0*)2.1是_vO-1HED_是(v*)3.
20、2中国_nsS-Ns3ATT_(A1*4.3人_nO1VOB_*)conll是一种表示语言分析结果的通用格式。在语言云的conll格式中，分析结果的每一行代表句子中每个词的信息，词标号从0开始。分析结果的基础列有10列，之后的每一列代表文本中的语义信息，每列之间用Tab分割。此列值为空用_占位。conll每列的含义请见下表：列号含义1单词在句子中的标号，从0开始2单词本身3空4空5单词词性标注信息6依存句法关系中的父亲节点标号7依存句法关系类型8空9空10如果单词是语义角色标注中的谓词，则为单词本身，否则为空11及以后每个谓词占一列，每一列为该谓词的语义角色标注信息*错误响应正常情况下，用户将得到正确的结果，此时HTTP状态为200 OK。$ curl -iHTTP/1.1 200 OK.但如果用户调用API的方式不当，服务器将会返回对应的错误，错误信息如下表所示:HTTP状态码错误信息说明400 Bad RequestURI PARAMETER ERRORAPI参数错误。请
