
# 依存句法分析
#### 功能介绍
识别句子中词汇与词汇之间的相互依存关系。
本API免费调用，调用限制为2次/秒。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=NLP&api=RunDependencyParser)中调试该接口。
#### 前提条件
在使用本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/dependency-parser
  ```
  

- 参数说明
  表1URI参数说明 
  | 参数名        | 必选 | 说明                                                                              |
  |:---|:---|:---|
  | project_id | 是  | 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nlp/nlp_03_0006.html)。 |
     
  
 
#### 请求消息
请求参数如[表 请求参数]所示。
 表2请求参数 
| 参数名  | 参数类型   | 必选 | 说明                           |
|:---|:---|:---|:---|
| text | String | 是  | 待分析文本，长度为1\~32，文本编码为UTF-8。   |
| lang | String | 否  | 支持的文本语言类型，目前只支持中文（zh），默认为中文。 |
   
#### 响应消息
响应参数如[表 响应参数]所示。
 表3响应参数 
| 参数名        | 参数类型                   | 说明                                                                                                                         |
|:---|:---|:---|
| words      | Array of words objects | 依存句法分析结果。 请参见[表 words数据结构说明]。                             |
| error_code | String                 | 调用失败时的错误码，具体参见[6.2 错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。 调用成功时无此字段。 |
| error_msg  | String                 | 调用失败时的错误信息。 调用成功时无此字段。                                                                          |
   
 表4words数据结构说明 
| 参数名              | 参数类型    | 说明                                                                                                                               |
|:---|:---|:---|
| id               | Integer | 词汇id，从1开始计数。                                                                                                                     |
| word             | String  | 词汇内容。                                                                                                                            |
| pos              | String  | 词性，请参见[表6](https://support.huaweicloud.com/api-nlp/nlp_03_0009.html#nlp_03_0009__table10434132119154)。                           |
| head_word_id     | Integer | 头节点id。如果是根节点，默认为0。                                                                                                               |
| dependency_label | String  | 词与头节点的依存关系，使用汉语开放依存句法树库（CODT）依存关系标签集合。 详细说明请参见[表 (CODT)关系类型说明]。 |
   
 表5(CODT)关系类型说明 
| 关系标签       | 说明                                                                                      | 例句                    | 标注结果                     |
|:---|:---|:---|:---|
| root       | sentence root（根节点）                                                                      | 我 爱 妈妈                | ( Root --\>爱)，其中Root为虚拟词 |
| sasubj-obj | same subject and object（同主语同宾语）                                                         | 我 一直 在 研究 和 思考 这个 问题。 | (研究--\>思考)               |
| sasubj     | same subject （同主语）                                                                      | 我 走进 操场 打 篮球。         | (走进--\>打)                |
| dfsubj     | different subject（不同主语）                                                                 | 这书太贵了，我打算买另一本         | (贵--\>打算)                |
| subj       | subject （主语）                                                                            | 我 爱 妈妈                | (我\<--爱)                 |
| subj-in    | subject inside a subject-predicate predicate （主谓谓语中的内部主语) | 他 确实 头 疼              | (头\<--疼)                 |
| obj        | object（宾语）                                                                              | 我 爱 妈妈                | (爱--\>妈妈)                |
| pred       | predicate （谓语)                                                                          | 命令 他 扫地               | (他--\>扫地)                |
| att        | attribute modifier（定语）                                                                  | 国家 主席                 | (国家\<--主席)               |
| adv        | adverbial modifier（状语）                                                                  | 非常 喜欢                 | (非常\<--喜欢)               |
| cmp        | complement modifier（补语）                                                                 | 洗 干净 手                | (洗--\>干净)                |
| coo        | coordination construction（并列结构）                                                         | 鲜花 和 掌声               | (鲜花--\>掌声)               |
| pobj       | preposition object（介宾）                                                                  | 在 家 看书                | (在--\>家)                 |
| iobj       | indirect-object（间宾）                                                                     | 给 他 书                 | (给--\>他)                 |
| de         | de-construction（"的"字结构）                                                                 | 这 是 他 的               | (他\<--的)                 |
| adjct      | adjunct（附加成分）                                                                           | 我 走 了                 | (走--\>了)                 |
| app        | appellation（称呼）                                                                         | 老师 ， 你 好              | (老师\<--好)                |
| exp        | explanation（进一步解释）                                                                      | 王刚（红星小学校长）            | (王刚--\>校长)               |
| punc       | punctuation（标点）                                                                         | 我 爱 妈妈 。              | (爱--\>。)                 |
| frag       | fragment（片段）                                                                            | 你， 我， 中国。             | (你--\>我--\>中国)           |
| repet      | repetition（重复）                                                                          | 你 吃 ， 吃 饭 了 吗 ？       | (吃--\>吃)                 |
   
#### 请求示例
调用API前，请先[构造请求](https://support.huaweicloud.com/api-nlp/nlp_03_0005.html)，通过[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)认证鉴权。
- 请求示例（分析"张三买电脑"的句法依存关系，支持的语言类型为中文）
  ```
  POST https://{endpoint}/v1/{project_id}/nlp-fundamental/dependency-parser
  Request Header: 
      Content-Type: application/json 
      X-Auth-Token: MIIFbwYJKoZIhvcNAQcCoIIFYDCCBVwCAQExDTALBglghkgBZQMEAgEwggNBgkqhkiG9... 
  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/dependency-parser'  # 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/dependency-parser");
              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();
      }
  }
  ```
  
#### 响应示例
- 成功响应示例
  ```
  {
      "words": [
          {
              "id": 1,
              "word": "张三",
              "pos": "NR",
              "head_word_id": 2,
              "dependency_label": "subj"
          },
          {
              "id": 2,
              "word": "买",
              "pos": "VV",
              "head_word_id": 0,
              "dependency_label": "root"
          },
          {
              "id": 3,
              "word": "电脑",
              "pos": "NN",
              "head_word_id": 2,
              "dependency_label": "obj"
          }
      ]
  }
  ```
  

- 失败响应示例
  ```
  {
      "error_code": "NLP.0301",
      "error_message": "Missing parameters:text"
  }
  ```
  
 
#### 状态码
状态码请参见[状态码](https://support.huaweicloud.com/api-nlp/nlp_03_0022.html)。
#### 错误码
错误码请参见[错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。
