# 命名实体识别（基础版）
#### 功能介绍
对文本进行命名实体识别分析，目前支持人名、地名、时间、组织机构类实体的识别。
具体Endpoint请参见[终端节点](https://support.huaweicloud.com/api-nlp/nlp_03_0032.html)。
调用华为云NLP服务会产生费用，本API支持使用**基础套餐包** ，购买时请在[自然语言处理价格计算器](https://www.huaweicloud.com/pricing.html#/nlp)中查看基础套餐包和领域套餐包支持的API范围。
本API调用限制为20次/秒。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=NLP&api=RunNer)中调试该接口。
#### 前提条件
在使用本API之前，需要您完成服务申请和认证鉴权，具体操作流程请参见[申请服务](https://support.huaweicloud.com/api-nlp/nlp_03_0004.html)和[认证鉴权](https://support.huaweicloud.com/api-nlp/nlp_03_0050.html)章节。
![](https://support.huaweicloud.com/api-nlp/public_sys-resources/note_3.0-zh-cn.png)
用户首次使用需要先[申请开通](https://console.huaweicloud.com/nlp/?region=cn-north-4#/nlp/overview)。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。
#### URI
- URI格式
  ```
  POST /v1/{project_id}/nlp-fundamental/ner
  ```
  

- 参数说明
  表1URI参数说明 
  | 参数名        | 必选 | 说明                                                                              |
  |:---|:---|:---|
  | project_id | 是  | 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nlp/nlp_03_0006.html)。 |
     
  
 
#### 请求消息
请求参数如[表2]所示。
 表2请求参数 
| 参数名  | 参数类型   | 必选 | 说明                                              |
|:---|:---|:---|:---|
| text | String | 是  | 待分析文本，中文长度为1\~512，英文和西班牙文长度为1\~2000，文本编码为UTF-8。 |
| lang | String | 否  | 支持的文本语言类型，目前支持中文（zh）,英文（en）,和西班牙文（es），默认为中文。    |
   
#### 响应消息
响应参数如[表3]所示。
 表3响应参数 
| 参数名            | 参数类型                          | 说明                                                                                                                      |
|:---|:---|:---|
| named_entities | Array of named_entity objects | 命名实体识别结果。 请参见[表4]。                                        |
| error_code     | String                        | 调用失败时的错误码，具体参见[错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。 调用成功时无此字段。 |
| error_msg      | String                        | 调用失败时的错误信息。 调用成功时无此字段。                                                                   |
   
 表4named_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...
  Request Body:
      {
          "text":"昨天程序员李小明来到北京参加开发者大赛，在比赛中表现优异，赢得了第一名。",
          "lang":"zh"
      }
  ```
  
- Python3语言请求代码示例（识别分析命名实体）
  ```
  # -*- coding: utf-8 -*-
  # 此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'
      header = {
          'Content-Type': 'application/json',
          'X-Auth-Token': token
      }
      body = {
          'text': '昨天程序员李小明来到北京参加开发者大赛，在比赛中表现优异，赢得了第一名。',
          'lang': 'zh'
      }
      resp = requests.post(url, data=json.dumps(body), headers=header)
      print(resp.json())
  if __name__ == '__main__':
      nlp_demo()
  ```
  
- Java语言请求代码示例（识别分析命名实体）
  ```
  import java.io.BufferedReader;
  import java.io.InputStream;
  import java.io.InputStreamReader;
  import java.io.OutputStreamWriter;
  import java.net.HttpURLConnection;
  import java.net.URL;
  /**
   * 此demo仅供测试使用，建议使用sdk
   */
  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."
  }
  ```
  
 
#### 状态码
状态码请参见[状态码](https://support.huaweicloud.com/api-nlp/nlp_03_0022.html)。
#### 错误码
错误码请参见[错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。