# 实体级情感分析
#### 功能介绍
实体级情感分析，本接口用于检测指定实体（entity）在文本（content）中的正负面分析，适用于金融方面公司实体正负面新闻的分析。
文本与实体长度的和不超过512字，编码方式UTF-8。建议对数据预处理，对于文本或实体为空的内容进行过滤。如果文本或实体为空，接口不支持。
本API免费调用，调用限制为2次/秒。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=NLP&api=RunEntitySentiment)中调试该接口。
#### 前提条件
在使用本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}/nlu/entity-sentiment
  ```
  

- 参数说明
  表1URI参数说明 
  | 名称         | 是否必选 | 说明                                                                              |
  |:---|:---|:---|
  | project_id | 是    | 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nlp/nlp_03_0006.html)。 |
     
  
 
#### 请求消息
请求参数如[表2]所示。
 表2请求参数 
| 名称      | 是否必选 | 参数类型    | 说明                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| content | 是    | String  | 请求文本，用于检查指定实体（entity）在该请求文本中的正负面分析。 仅支持中文，文本编码要求为utf-8。请求文本内容不能为空，且请求文本与请求实体的长度和不超过512字。长度超过512时，只检测前512个字符。                                                                            |
| entity  | 是    | String  | 请求实体，用于检查该请求实体在文本（content）中的正负面分析。 说明： 不同实体（entity）在同一文本（content）的正负面分析会存在不同的分析结果。 仅支持中文，文本编码要求为utf-8。请求实体内容不能为空，且请求文本与请求实体的长度和不超过512字。长度超过512时，只检测前512个字符。 |
| type    | 是    | integer | 实体级情感分析适用领域，取值如下。 "3" ：金融领域                                                                                                                                                              |
   
#### 响应消息
响应参数如[表3]所示。
 表3响应参数 
| 名称         | 参数类型    | 说明                                                                                                                      |
|:---|:---|:---|
| confidence | double  | 该实体在文本中的情感label的置信度                                                                                                     |
| content    | String  | 响应文本。                                                                                                                   |
| entity     | String  | 响应实体。                                                                                                                   |
| label      | integer | 该实体在文本中的情感标签，0表示负面，1表示非负面，2表示不相关。                                                                                       |
| error_code | string  | 调用失败时的错误码。具体参见[错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。 调用成功时无此字段。 |
| error_msg  | string  | 调用失败时的错误信息。 调用成功时无此字段。                                                                   |
   
#### 请求示例
- 请求示例（检测金融领域中云端金融在杭州云端金融信息服务有限公司涉嫌非法吸取公众存款案例的正负面分析）
  ```
  POST https://nlp-ext.cn-north-4.myhuaweicloud.com/v1/{{project_id}}/nlu/entity-sentiment
  Request Header: 
  Content-Type: application/json 
  X-Auth-Token:MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... 
  Request Body: 
  {
      "content" : "杭州云端金融信息服务有限公司涉嫌非法吸取公众存款案例",
      "entity": "云端金融",
      "type": 3
    }
  ```
  
- Python3语言请求代码示例（检测金融领域中云端金融在杭州云端金融信息服务有限公司涉嫌非法吸取公众存款案例的正负面分析）
  ```
  # -*- coding: utf-8 -*-
  # 此demo仅供测试使用，建议使用sdk。需提前安装requests，执行pip install requests
  import requests
  import json
  def nlp_demo():
      url = 'https://{endpoint}/v1/{project_id}/nlu/entity-sentiment'  # endpoint和project_id需替换
      token = '用户对应region的token'
      header = {
          'Content-Type': 'application/json',
          'X-Auth-Token': token
      }
      body = {
          'content': '杭州云端金融信息服务有限公司涉嫌非法吸取公众存款案例',
          'entity': '云端金融',
          'type': 3
      }
      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}/nlu/entity-sentiment");
              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 content = "杭州云端金融信息服务有限公司涉嫌非法吸取公众存款案例";
              String entity = "云端金融";
              String body = "{\"content\":\"" + content + "\" ,\"entity\":\"" + entity + "\" ,\"type\":3}";
              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();
      }
  }
  ```
  
 
#### 响应示例
- 成功响应示例
  ```
  {
  "confidence": 0.999,
  "content": "杭州云端金融信息服务有限公司涉嫌非法吸取公众存款案例",
  "entity": "云端金融",
  "label": 0
  }
  ```
  
- 失败响应示例
  ```
  {
  "error_code": "NLP.0301",
  "error_msg": "entity must not null"
  }
  ```
  
 
#### 状态码
状态码请参见[状态码](https://support.huaweicloud.com/api-nlp/nlp_03_0022.html)。
#### 错误码
错误码请参见[错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。