上传NLP分词词典
更新时间：2023-08-11
接口描述
支持用户通过api配置NLP分词词典
上传词典接口
请求路径
POST /api/bes/cluster/nlp_dict/update
请求参数
Header参数
| 参数名 | 类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| x-Region | String | 是 | 区域 | bd |
| authorization | String | 是 | 认证字符串，计算方法请参考生成认证字符串。 | bce-auth-v1/{accessKey}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature} |
Body参数
| 参数名 | 类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| clusterId | 是 | String | 集群id | 572979545519558656 |
| clusterId | 是 | String | 代表nlp词典的配置模式，可选参数：upload_dict（上传词典文件）, text（输入文本）, reset_dict（重置词典）。 | |
| fileName | 否 | String | 上传的词典文件名称，当配置模式选择上传词典文件（upload_dict）时必须填写。 | test.txt |
| bucketName | 否 | String | BOS的Bucket的名称，当配置模式选择上传词典文件（upload_dict）时必须填写。 | test_bucket |
| bucketKey | 否 | String | 词典文件在BOS Bucket中的存储路径，当配置模式选择上传词典文件（upload_dict）时必须填写。 | /test_path/.../test.txt |
| separator | 否 | String | 上下文分隔符规则，默认值为tab。可选参数：tab、space(空格)。例如：（1）干预规则为tab： 中华(tab)民(空格)国 -- 切词结果：中华，民(空格)国。（2）干预规则为空格：中华(tab)民(空格)国 -- 切词结果：中华，民，国 | |
| dictContent | 否 | String | 直接输入文本作为词典，当配置方式选择输入文本（text）时必须填写。内容中可以使用"\n"代表分行符，使用"[]"作为短语干预符，使用"\t"、空格来代表上下文分隔符，且限制1000000个字符。 | 中华 人民 共和国\n中华 [人民 共和国]\n中华\n人民\n共和国 |
请求示例
Plain Text
1POST /api/bes/cluster/nlp_dict/update
2{
3 "clusterId": 1111111,
4 "mode": "upload_dict",
5 "fileName": "test.txt",
6 "bucketName": "test_bucket",
7 "bucketKey": "/test_path/.../test.txt",
8 "separator": "tab"
9}响应参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| success | 是 | Boolean | 标识请求是否成功，true/false |
| status | 是 | String | 状态码 |
| result | 是 | Object | 词典详情 |
Result字段数据结构说明
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| code | 是 | String | 错误码 |
| message | 是 | String | 请求详情 |
响应示例
Plain Text
1{
2 "success": true,
3 "status": 200,
4 "result": {
5 "code": "Success",
6 "message": ""
7 }
8}错误详情
| 错误码（code） | 请求详情（message) | 描述 |
|---|---|---|
| SUCCESS | - | 请求成功 |
| INVALID_ENTITY_TOO_LARGE | The dictContent exceeds the 1000000 character limit. | 当配置方式选择输入文本（text）时，dictContent内容超过1000000字符限制 |
| INVALID_ENTITY_TOO_LARGE | The dict file is too large. | 当配置模式选择上传词典文件（upload_dict）时，词典文件超过10M |
| INVALID_CLUSTER_ID | The cluster id is not valid. | 集群id不存在 |
| CLUSTER_NEED_UPGRADE | The ES Version need more than 7.x. | ES至少需要7.x版本以上 |
| CLUSTER_NEED_UPGRADE | The ES Node memory requires at least 64g. | ES节点内存配置至少需要64G |
| INVALID_PARAMETER | The value of request parameter is invalid, Please check the required field . | 请求参数有误，请检查必填项或字段格式 |
| INVALID_NLP_DICT_FILE | The dictionary file is not a txt file. | 词典文件不是txt文件 |
| PERMISSION_DENY | Permission deny. | 权限不足，需要BES OPERATE权限 |
| INVALID_FILE | The bucket or file not exist or banned. | bucket或文件不存在或不允许访问 |
| UNKNOW | Unknow error. | 未知错误 |
查看词典接口
请求路径
POST /api/bes/cluster/nlp_dict/update
请求参数
Header参数
| 参数名 | 类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| x-Region | String | 是 | 区域 | bd |
| authorization | String | 是 | 认证字符串，计算方法请参考生成认证字符串。 | bce-auth-v1/{accessKey}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature} |
Body参数
| 参数名 | 类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| clusterId | String | 是 | 集群id | 572979545519558656 |
请求示例
Plain Text
1POST /api/bes/cluster/nlp_dict/display
2{
3 "clusterId": 1111111
4}响应参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| success | 是 | Boolean | 标识请求是否成功，true/false |
| status | 是 | String | 状态码 |
| result | 是 | Object | 词典详情 |
Result字段数据结构说明
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| operationType | 是 | String | upload_dict（上传词典文件）, text（输入文本） |
| separator | 是 | String | 上下文分隔符规则 |
| fileName | 是 | String | 若使用上传词典的方式，则此字段有值，代表上传词典的名称 |
| dictContent | 是 | String | 若使用输入文本的方式，则此字段有值，代表详细词典内容 |
响应示例
Plain Text
1{
2 "success": true,
3 "status": 200,
4 "result": {
5 "operationType": "upload_dict",
6 "separator": "tab",
7 "fileName": "test.txt",
8 "dictContent": null
9 }
10}