
# 文本摘要（领域版）
#### 功能介绍
根据不同领域的语料训练特定领域的摘要模型，能有效提升文本摘要的效果。
文本摘要（基础版）和文本摘要（领域版）基于不同算法实现，对相同文本，基础版和领域版的结果有所差别。根据测试数据，领域版效果一般优于基础版。
本API免费调用，调用限制为2次/秒。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=NLP&api=RunSummaryDomain)中调试该接口。
#### 前提条件
在使用本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}/nlg/summarization/domain
  ```
  
- 参数说明
  表1URI参数说明 
  | 名称         | 是否必选 | 说明                                                                              |
  |:---|:---|:---|
  | project_id | 是    | 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nlp/nlp_03_0006.html)。 |
     
  
 
#### 请求消息
请求参数如下所示。
表2请求参数 
| 名称           | 是否必选 | 参数类型    | 说明                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| lang         | 否    | String  | 支持的文本语言类型，目前支持中文（zh），默认为中文。                                                                                                                                                                                                                                                                    |
| title        | 否    | String  | 文本标题（目前仅支持UTF-8编码），长度不超过1000字。                                                                                                                                                                                                                                                                 |
| content      | 是    | String  | 文本正文（目前仅支持UTF-8编码），长度1\~10000字。                                                                                                                                                                                                                                                                |
| length_limit | 否    | float   | 生成摘要的长度限制。 - length_limit \> 1，则为摘要的具体字数。  - 0 \<= length_limit \<= 1，则为生成摘要占原文长度的百分比。   默认数值为0.3。 |
| type         | 否    | Integer | 支持的领域类型，取值如下（目前只支持通用领域），默认为通用领域： 0：通用领域                                                                                                                                                                                                                           |
   
#### 响应消息
响应参数如[表3]所示。
 表3响应参数 
| 名称         | 参数类型   | 说明                                                                                                                      |
|:---|:---|:---|
| summary    | String | 根据文本请求体，返回摘要结果。                                                                                                         |
| error_code | String | 调用失败时的错误码，具体参见[错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。 调用成功时无此字段。 |
| error_msg  | String | 调用失败时的错误信息。 调用成功时无此字段。                                                                   |
   
#### 请求示例
- 请求示例（生成文本摘要，长度限制为0.3）
  ```
  POST https://{endpoint}/v1/{project_id}/nlg/summarization/domain
  Request Header:
      Content-Type: application/json
      X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...   //用户认证获取的token值，获取方法详细请参考“如何调用API”章节中的“认证鉴权”页面。
  Request Body:
      {
         "length_limit":0.3,
         "title":"华为“刀片式基站”获2018年度国家科学技术进步奖一等奖",
         "lang": "zh",
         "content": "华为刀片式基站解决方案是华为在深入理解客户诉求基础上，引领业界的创新解决方案。该方案采用统一的模块化设计，实现基站主要元素如射频、基带、电源、电池、微波、传输的刀片化，不同模块间的任意快速拼装组合无缝拼装，能灵活安装在抱杆，铁塔，墙面或者屋顶，“0”站址无需机房机柜，使基站的安装像拼装乐高积木一样简单便捷。刀片式基站同时支持2G/3G/4G等多制式，在多频多模网络发展策略下可以高效利用宝贵的站点资源，大幅降低站点获取难度和减少站点租金，帮助运营商应对移动网络快速增长的容量需求。同时刀片式基站采用自然散热，满足室外55℃高温环境，IP65防护等级，无需机房机柜和空调，其高能效和环境友好的特性，帮助运营商打造绿色移动网络。自2012年推出以来，刀片式基站全球累计已发货超1500万片，在全球超过170个国家310张运营商网络中成功商用部署。全球客户高度肯定了华为创新刀片式基站解决方案，它不但打破了传统机柜站点占地面积大、运维复杂的建站模式，而且还有效地提高了站点的部署效率，特别在密集城区、高铁场景下解决站点空间受限、实现快速部署、降低租赁成本等方面效果显著，同时也为乡村广覆盖场景提供最简单站点方案。在5G时代，华为围绕客户需求持续创新，在2018全球移动宽带论坛上，华为亦推出Super Blade Site——面向5G全室外站解决方案，其中包含最新支持5G容量要求的室外基带单元Blade BBU和有源天线一体化产品Blade AAU，该解决方案进一步匹配5G的最新技术要求和容量要求，极大降低5G引入对天面空间的需求，加速Massive MIMO部署，帮助运营商布局5G网络。华为Super Blade Site在2018全球移动宽带论坛上展出华为无线网络研发总裁郦舟剑表示，“华为一直致力于围绕客户需求持续创新，刀片式基站就是典型的例子。刀片式基站解决客户获取站址难题，帮助运营商快速建站，满足移动业务的迅猛增长的需求，也给客户带来商业成功。同时，面对即将到来的5G时代，华为持续创新，全室外刀片基站解决方案，将助力5G快速规模商用，帮助客户取得更大的商业成功。”国家科学技术进步奖，是国务院设立的国家科学技术奖5大奖项（国家最高科学技术奖、国家自然科学奖、国家技术发明奖、国家科学技术进步奖、国际科学技术合作奖）之一。该奖项授予在技术研究、技术开发、技术创新、推广应用先进科学技术成果、促进高新技术产业化，以及完成重大科学技术工程、计划等过程中做出创造性贡献的中国公民和组织。",
        "type":0
      }
  ```
  
- Python3语言请求代码示例（生成文本摘要，长度限制为0.3）
  ```
  # -*- coding: utf-8 -*-
  # 此demo仅供测试使用，建议使用sdk。需提前安装requests，执行pip install requests
  import requests
  import json
  def nlp_demo():
      url = 'https://{endpoint}/v1/{project_id}/nlg/summarization/domain'  # endpoint和project_id需替换
      token = '用户对应region的token'
      header = {
          'Content-Type': 'application/json',
          'X-Auth-Token': token
      }
      body = {
          'length_limit': 0.3,
          'title': '华为“刀片式基站”获2018年度国家科学技术进步奖一等奖',
          'lang': 'zh',
          'content': '华为刀片式基站解决方案是华为在深入理解客户诉求基础上，引领业界的创新解决方案。该方案采用统一的模块化设计，实现基站主要元素如射频、基带、电源、电池、微波、传输的刀片化，不同模块间的任意快速拼装组合无缝拼装，能灵活安装在抱杆，铁塔，墙面或者屋顶，“0”站址无需机房机柜，使基站的安装像拼装乐高积木一样简单便捷。刀片式基站同时支持2G/3G/4G等多制式，在多频多模网络发展策略下可以高效利用宝贵的站点资源，大幅降低站点获取难度和减少站点租金，帮助运营商应对移动网络快速增长的容量需求。同时刀片式基站采用自然散热，满足室外55℃高温环境，IP65防护等级，无需机房机柜和空调，其高能效和环境友好的特性，帮助运营商打造绿色移动网络。自2012年推出以来，刀片式基站全球累计已发货超1500万片，在全球超过170个国家310张运营商网络中成功商用部署。全球客户高度肯定了华为创新刀片式基站解决方案，它不但打破了传统机柜站点占地面积大、运维复杂的建站模式，而且还有效地提高了站点的部署效率，特别在密集城区、高铁场景下解决站点空间受限、实现快速部署、降低租赁成本等方面效果显著，同时也为乡村广覆盖场景提供最简单站点方案。在5G时代，华为围绕客户需求持续创新，在2018全球移动宽带论坛上，华为亦推出Super Blade Site——面向5G全室外站解决方案，其中包含最新支持5G容量要求的室外基带单元Blade BBU和有源天线一体化产品Blade AAU，该解决方案进一步匹配5G的最新技术要求和容量要求，极大降低5G引入对天面空间的需求，加速Massive MIMO部署，帮助运营商布局5G网络。华为Super Blade Site在2018全球移动宽带论坛上展出华为无线网络研发总裁郦舟剑表示，“华为一直致力于围绕客户需求持续创新，刀片式基站就是典型的例子。刀片式基站解决客户获取站址难题，帮助运营商快速建站，满足移动业务的迅猛增长的需求，也给客户带来商业成功。同时，面对即将到来的5G时代，华为持续创新，全室外刀片基站解决方案，将助力5G快速规模商用，帮助客户取得更大的商业成功。”国家科学技术进步奖，是国务院设立的国家科学技术奖5大奖项（国家最高科学技术奖、国家自然科学奖、国家技术发明奖、国家科学技术进步奖、国际科学技术合作奖）之一。该奖项授予在技术研究、技术开发、技术创新、推广应用先进科学技术成果、促进高新技术产业化，以及完成重大科学技术工程、计划等过程中做出创造性贡献的中国公民和组织。',
          'type': 0
      }
      resp = requests.post(url, data=json.dumps(body), headers=header)
      print(resp.json())
  if __name__ == '__main__':
      nlp_demo()
  ```
  
- Java语言请求代码示例（生成文本摘要，长度限制为0.3）
  ```
  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}/nlg/summarization/domain");
              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 title = "小德3-0费德勒首进澳网决赛 天王遭遇08年首败";
              String content = "搜狐体育讯 北京时间1月25日,2008年首项大满贯赛事--澳大利亚网球公开赛进入第12日角逐。在罗德-拉沃尔球场进行的男单第二场半决赛争夺中,大赛3号种子、塞尔维亚天才少年德约科维奇出人意料的直落三盘,以总比分3-0横扫大赛头号种子、瑞士天王费德勒,职业生涯首进澳网男单决赛,同时这也是德约科维奇第二次杀入大满贯赛事男单决赛。三盘的具体比分为7-5、6-3和7-6(5)。费德勒无缘卫冕,这是瑞士天王在2008年输掉的首场比赛,也是他自从2005年法网之后,首度无缘大满贯赛事男单决赛;瑞士天王在墨尔本的19连胜就此终结。德约科维奇在男单决赛中的对手将是法国黑人小将特松加。您认为费天王失利的原因是什么?作为世界头号选手,以及三届澳网冠军,费德勒这两年在墨尔本的表现相当不错。本届澳网,费德勒的状态很一般,特别是第三轮他经过五盘苦战才力擒塞尔维亚眼镜侠提普萨勒维奇。在此之前,费德勒连续10项大满贯闯入决赛;连续15项大满贯晋级四强。德约科维奇已经创下个人在澳网的最佳战绩,这位塞尔维亚天才少年渴望连续第二年挺进大满贯赛事男单决赛。在此之前,费德勒与德约科维奇总共有过六次交锋。";
              String body = "{\"title\":\"" + title + "\",\"content\":\"" + content + "\",\"length_limit\":0.3,\"lang\": \"zh\",\"type\": 0}";
              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();
      }
  }
  ```
  
 
#### 响应示例
- 成功响应示例
  ```
  {
      "summary" : "华为刀片式基站解决方案是华为在深入理解客户诉求基础上，引领业界的创新解决方案。该方案采用统一的模块化设计，实现基站主要元素如射频、基带、电源、电池、微波、传输的刀片化，不同模块间的任意快速拼装组合无缝拼装，能灵活安装在抱杆，铁塔，墙面或者屋顶，“0”站址无需机房机柜，使基站的安装像拼装乐高积木一样简单便捷。刀片式基站同时支持2G/3G/4G等多制式，在多频多模网络发展策略下可以高效利用宝贵的站点资源，大幅降低站点获取难度和减少站点租金，帮助运营商应对移动网络快速增长的容量需求。该奖项授予在技术研究、技术开发、技术创新、推广应用先进科学技术成果、促进高新技术产业化，以及完成重大科学技术工程、计划等过程中做出创造性贡献的中国公民和组织。"
  }
  ```
  
- 失败响应示例
  ```
  {
      "error_code": "NLP.3104",
      "error_msg": "content is empty."
  }
  ```
  
 
#### 状态码
状态码请参见[状态码](https://support.huaweicloud.com/api-nlp/nlp_03_0022.html)。
#### 错误码
错误码请参见[错误码](https://support.huaweicloud.com/api-nlp/nlp_03_0021.html)。
