4.1 自然语言处理基础服务接口说明
4.1.4 命名实体识别(基础版)
功能介绍
对文本进行命名实体识别分析,目前支持人名、地名、时间、组织机构类实体的识 别。
具体Endpoint请参见终端节点。
调用华为云NLP服务会产生费用,本API支持使用基础套餐包,购买时请在自然语言处
理价格计算器中查看基础套餐包和领域套餐包支持的API范围。
调试
您可以在API Explorer中调试该接口。
前提条件
在使用本API之前,需要您完成服务申请和认证鉴权,具体操作流程请参见申请服务和
认证鉴权章节。
说明
用户首次使用需要先申请开通。服务只需要开通一次即可,后面使用时无需再次申请。如未开通 服务,调用服务时会提示ModelArts.4204报错,请在调用服务前先进入控制台开通服务,并注 意开通服务区域与调用服务的区域保持一致。
URI
● URI格式
POST /v1/{project_id}/nlp-fundamental/ner
● 参数说明
表4-17 URI 参数说明
参数名 必选 说明
project_id 是 项目编号。获取方法,请参见获取项目ID。
请求消息
请求参数如表4-18所示。
表4-18 请求参数
参数名 参数类型 必选 说明
text String 是 待分析文本,中文长度为1~512,英文 和西班牙文长度为1~2000,文本编码 为UTF-8。
参数名 参数类型 必选 说明
lang String 否 支持的文本语言类型,目前支持中文
(zh),英文(en),和西班牙文
(es),默认为中文。
响应消息
响应参数如表4-19所示。
表4-19 响应参数
参数名 参数类型 说明
named_entitie
s Array of named_entity objects
命名实体识别结果。
请参见表4-20。
error_code String 调用失败时的错误码,具体参见错误码。
调用成功时无此字段。
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
表4-20 named_entity 数据结构说明
参数名 参数类型 说明
word String 实体文本。
tag String 实体类型,枚举类型。
● 中文支持人名“nr”,地名“ns”,机构 名“nt”,时间“t”。
● 英文支持人名“per”,地名“loc”,机 构名“org”,时间“t”。
● 西班牙文支持人名“per”,地名
“loc”,机构名“org”,时间“t”。
offset Integer 实体文本在待分析文本中的起始位置。
len Integer 实体文本长度。
示例
● 请求示例
POST https://{endpoint}/v1/{project_id}/nlp-fundamental/ner Request Header:
Content-Type: application/json X-Auth-Token:
MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
-*-# 此demo仅供测试使用,建议使用sdk。需提前安装requests,执行pip install requests import requests
import json def nlp_demo():
url = 'https://{endpoint}/v1/{project_id}/nlp-fundamental/ner' # endpoint和project_id需替换 token = '用户对应region的token'
resp = requests.post(url, data=json.dumps(body), headers=header) print(resp.text)
if __name__ == '__main__':
nlp_demo() */public class NLPDemo {
public void nlpDemo() { try {
//endpoint和projectId需要替换成实际信息。
URL url = new URL("https://{endpoint}/v1/{project_id}/nlp-fundamental/ner");
String token = "对应region的token";
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setDoInput(true);
connection.setDoOutput(true);
connection.addRequestProperty("Content-Type", "application/json");
connection.addRequestProperty("X-Auth-Token", token);
//输入参数
String text = "昨天程序员李小明来到北京参加开发者大赛,在比赛中表现优异,赢得了第一名。";
String body = "{\"text\":\"" + text + "\",\"lang\":\"zh\"}";
OutputStreamWriter osw = new OutputStreamWriter(connection.getOutputStream(),
"UTF-8");
osw.append(body);
osw.flush();
InputStream is = connection.getInputStream();
BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
while (br.ready()) {
System.out.println(br.readLine());
}
} catch (Exception e) { e.printStackTrace();
} }
public static void main(String[] args) { NLPDemo nlpDemo = new NLPDemo();
nlpDemo.nlpDemo();
} }
● 响应示例
– 成功响应示例
{ "named_entities": [ {
"word": "昨天", "tag": "t", "offset": 0, "len": 2 }, {
"word": "李小明", "tag": "nr", "offset": 5, "len": 3 }, {
"word": "北京", "tag": "ns", "offset": 10, "len": 2 } ] }
– 失败响应示例
{ "error_code": "NLP.0301",
"error_msg": "The length of text should be in the range of 1-2000."
}
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。