# 句向量
#### 功能介绍
输入句子，返回对应的句向量。
具体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=RunSentenceEmbedding)中调试该接口。
#### 前提条件
在使用本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/sentence-embedding
  ```
  
- 参数说明
  表1URI参数说明 
  | 参数名        | 必选 | 说明                                                                              |
  |:---|:---|:---|
  | project_id | 是  | 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nlp/nlp_03_0006.html)。 |
     
  
 
#### 请求消息
请求参数[表2]所示。
 表2请求参数 
| 参数名       | 参数类型             | 必选 | 说明                                                |
|:---|:---|:---|:---|
| sentences | Array of strings | 是  | 文本列表，文本长度为1\~512，列表大小为1\~1000，文本编码为UTF-8，目前只支持中文。 |
| domain    | String           | 否  | 计算句向量时使用的模型名，目前只支持general，默认为general。             |
   
#### 响应消息
响应参数如[表3]所示。
 表3响应参数 
| 参数名        | 参数类型            | 说明                                                                                                                       |
|:---|:---|:---|
| vectors    | Array of floats | 句向量结果列表，按输入句子顺序返回句向量，句向量维度默认为100。                                                                                        |
| error_code | String          | 调用失败时的错误码，具体参见[错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。 调用成功时无此字段。 |
| error_msg  | String          | 调用失败时的错误信息。 调用成功时无此字段。                                                                    |
   
#### 请求示例
- 请求示例（计算句向量）
  ```
  POST https://{endpoint}/v1/{project_id}/nlp-fundamental/sentence-embedding
  Request Header:
      Content-Type: application/json
      X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  Request Body:
      {
          "sentences":["今天张三来学校了","今天李四来学校了"], 
          "domain":"general"
      }
  ```
  
- 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/sentence-embedding'  # endpoint和project_id需替换
      token = '用户对应region的token'
      header = {
          'Content-Type': 'application/json',
          'X-Auth-Token': token
      }
      body = {
          'sentences': ['今天张三来学校了', '今天李四来学校了'],
          'domain': 'general'
      }
      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/sentence-embedding");
              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 sentences = "["今天张三来学校了","今天李四来学校了"]";
              String body = "{\"sentences\":" + sentences + ", \"domain\":\"general\"}";
              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();
      }
  }
  ```
  
 
#### 响应示例
- 成功响应示例
  ```
  {
    "vectors": [
      [0.1331, 0.0488, 0.2441, 0.2514, -0.6771, 0.4782, 0.6759, 0.015, 0.0064, -0.6326, 0.3958, -0.6848, 0.1118, -0.1391, 0.4804, 0.9294, 0.1004, 0.2414, 0.2477, -0.8162, 1.2052, -0.6719, -0.47, -0.1946, -0.0606, 0.473, 0.0247, -0.3857, 1.1637, -0.6092, -0.5512, -0.2389, -0.2168, 0.1673, -0.4124, -0.1196, -0.7147, 1.1774, -0.8166, 0.1285, -0.3136, 0.4687, -0.5939, -0.4579, 0.1857, 0.049, -0.5936, -0.4554, -0.1878, 0.017],
      [0.0833, -0.0731, 0.298, 0.0085, -0.6858, 0.529, 0.887, 0.1772, -0.118, -0.7559, 0.1995, -0.6415, 0.3014, 0.2061, 0.9727, 0.9089, 0.1603, 0.3773, -0.146, -0.6429, 1.4808, -0.7797, -0.6061, -0.0854, -0.1324, 0.3183, 0.3378, -0.4552, 1.4929, -0.7543, -0.6089, -0.1906, -0.1892, 0.0628, -0.4675, -0.2478, -0.7632, 1.1876, -1.0734, -0.0954, -0.2896, 0.5757, -0.5601, -0.2595, 0.3831, 0.4729, -0.8736, -0.4378, -0.2519, 0.0448]
    ]
  }
  ```
  
- 失败响应示例
  ```
  {
      "error_code": "NLP.0301",
      "error_msg": "argument valid error: sentence must not be blank and sentence length 1-512"
  }
  ```
  
 
#### 状态码
状态码请参见[状态码](https://support.huaweicloud.com/api-nlp/nlp_03_0022.html)。
#### 错误码
错误码请参见[错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。