YesApi 接口文档

1201 中文分词接口 App.Scws.GetWords

接口路径(新):http://api.yesapi.net/api/App/Scws/GetWords

接口路径(旧):http://api.yesapi.net/?s=App.Scws.GetWords

接口描述: NLP分词,可进行中文分词。

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

接口流量
3
请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试接口    收藏此接口    在线接口开发    接口请求日记    下载接口文档(md格式)


接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,点击查看,或免费注册
sign字符串可选公共参数接口签名,其中:
  1. 关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。
  2. 静态签名,简单,固定的签名,点击获取
  3. 动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包在线测试对比签名。
  4. 定制签名,支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构,其中:
  1. return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}
  2. return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求,1表示允许,0表示不允许。
text字符串必须我爱你中国待进行中文分词的文本

在线测试

参数是否必填
s 固定
uuid 可选
token 可选
return_data 可选
yesapi_allow_origin 可选
text 必须

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

我的客户端是【XXX】,需求是【XXX】,app_key是【XXX】,请根据以下接口文档,完成API接入。


# 【 1201 中文分词接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://api.yesapi.net/?s=App.Scws.GetWords`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  NLP分词,可进行中文分词。
- **返回格式**: JSON

## 请求参数说明

### 系统参数(使用Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名,固定为`App.Scws.GetWords` |
| app_key | string | 必填 | 应用key,传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名,其中:                  关闭签名,默认,不需要签名,在接口签名设置关闭或开启接口签名。         静态签名,简单,固定的签名,点击获取。         动态签名,复杂,安全系数高,获取密钥,教程:如何生成签名,下载SDK开发包,在线测试对比签名。         定制签名,支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构,其中:         return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"};         return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求,1表示允许,0表示不允许。 |


### 业务参数(使用POST或Query传递)
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| text | string | 必填 | 待进行中文分词的文本 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时,接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.words | array | 分词的结果|
| data.words[].word | string | 词本身|
| data.words[].idf | float | 逆文本词频|
| data.words[].off | int | 该词在原文本路的位置|
| data.words[].attr | string | 词性,北大词性标注版本:Ag 形语素a 形容词ad 副形词an 名形词b 区别词c 连词Dg 副语素d 副词e 叹词f 方位词g 语素h 前接成分i 成语j 简称略语k 后接成分l 习用语m 数词Ng 名语素n 名词nr 人名ns 地名nt 机构团体nz 其他专名o 拟声词ba 介词 把、将bei 介词 被p 介词q 量词r 代词s 处所词Tg 时语素t 时间词dec 助词 的、之  deg 助词 得 di 助词 地 etc 助词 等、等等 as 助词 了、着、过 msp 助词 所 u 其他助词Vg 动语素v 动词vd 副动词vn 名动词w 其他标点符号x 非语素字y 语气词z 状态词|


## 请求示例

```bash
curl -X POST "http://api.yesapi.net/?s=App.Scws.GetWords&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例(ret=200表示成功请求,data为成功后的业务数据):
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例:
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求:xxx参数错误"
}
```
请求:
{你的接口域名}/?s=App.Scws.GetWords&text=我爱你中国&app_key={你的app_key}&sign={接口签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "words": [
        {
            "word": "我爱你",
            "off": 0,
            "len": 9,
            "idf": 4.929999828338623,
            "attr": "n"
        },
        {
            "word": "中国",
            "off": 9,
            "len": 6,
            "idf": 6.260000228881836,
            "attr": "ns"
        }
        ]
    },
    "msg": "小白开放接口:App.Scws.GetWords"
}

接口返回

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
dataobject/array/混合接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。
data.words字符串分词的结果
data.words[].word字符串词本身
data.words[].idf浮点型逆文本词频
data.words[].off整型该词在原文本路的位置
data.words[].attr字符串词性,北大词性标注版本:
  • Ag 形语素
  • a 形容词
  • ad 副形词
  • an 名形词
  • b 区别词
  • c 连词
  • Dg 副语素
  • d 副词
  • e 叹词
  • f 方位词
  • g 语素
  • h 前接成分
  • i 成语
  • j 简称略语
  • k 后接成分
  • l 习用语
  • m 数词
  • Ng 名语素
  • n 名词
  • nr 人名
  • ns 地名
  • nt 机构团体
  • nz 其他专名
  • o 拟声词
  • ba 介词 把、将
  • bei 介词 被
  • p 介词
  • q 量词
  • r 代词
  • s 处所词
  • Tg 时语素
  • t 时间词
  • dec 助词 的、之  
  • deg 助词 得
  • di 助词 地
  • etc 助词 等、等等
  • as 助词 了、着、过
  • msp 助词 所
  • u 其他助词
  • Vg 动语素
  • v 动词
  • vd 副动词
  • vn 名动词
  • w 其他标点符号
  • x 非语素字
  • y 语气词
  • z 状态词
msg字符串提示信息,面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳,例如:1657513450
_auth字符串反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串),若需要关闭或开启请提交工单

异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求表示客户端参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 404客户端非法请求表示接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 500小白接口异常表示服务端内部错误1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。

Q2 问:浏览器请求和在线测试接口正常,但本地程序无法正常获取接口结果答:需要注意UTF编码,以及存在中文和特殊字符时的URL编码。GET请求参数应统一进行URL编码后再请求,POST表单数据正常传递即可。

Q3 问:请求接口时提示JSON格式错误答:请先阅读,然后检测本地传递的参数是否符合JSON格式,使用JSON在线工具辅助检测,注意双引号和特殊符号。确认无误后再重新请求API接口。

Q4 问:出现 405 不允许跨域请求 时怎么办?答:可以追加GET参数 &yesapi_allow_origin=1,或参考用反向代理解决跨域问题等3种解决方案。

Q4 问:在wx内无法访问yesapi.cn或okayapi.com域名,怎么办?答:由于曾经短链跳转使用被wx误封域名,可以帮忙进行申诉。申诉后截图联系我们,获取15万次接口流量奖励。