更新时间:2022-05-06 GMT+08:00
分享

实体链接

功能介绍

针对通用领域的文本进行实体链接分析,识别出其中的实体,并返回实体相关信息。

具体Endpoint请参见终端节点

调用华为云NLP服务会产生费用,本API以定制版API定价按需计费,不支持使用套餐包,使用时请在自然语言处理价格计算器 按需计费-自然语言处理定制版API中查看费用详情。

本API调用限制为20次/秒。

调试

您可以在API Explorer中调试该接口。

前提条件

在使用本API之前,需要您完成服务申请和认证鉴权,具体操作流程请参见申请服务认证鉴权章节。

用户首次使用需要先申请开通。服务只需要开通一次即可,后面使用时无需再次申请。如未开通服务,调用服务时会提示ModelArts.4204报错,请在调用服务前先进入控制台开通服务,并注意开通服务区域与调用服务的区域保持一致。

URI

  • URI格式
    POST /v1/{project_id}/nlp-fundamental/entity-linking
  • 参数说明
    表1 URI参数说明

    参数名

    必选

    说明

    project_id

    项目编号。获取方法,请参见获取项目ID

请求消息

请求参数如表2所示。

表2 请求参数

参数名

参数类型

必选

说明

text

String

待分析文本,长度为1~50,文本编码为UTF-8。

lang

String

支持的文本语言类型,目前只支持中文(zh),默认为中文。

响应消息

响应参数如表3所示。

表3 响应参数

参数名

参数类型

说明

entities

Array of entities

实体链接结果,请参见表4

error_code

String

调用失败时的错误码,具体参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

表4 entity数据结构说明

参数名

参数类型

说明

mention

String

实体指称。

offset

Integer

偏移量。

entity_title

String

指称链接到的实体名称。

示例

  • 请求示例
    POST https://{endpoint}/v1/{project_id}/nlp-fundamental/entity-linking
    
    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/entity-linking'  # 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.text)
    
    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/entity-linking");
                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();
        }
    }
  • 响应示例
    • 成功响应示例
      {
          "entities": [
              {
                  "mention": "李娜",
                  "offset": 0,
                  "entity_title": "李娜(流行歌手、佛门女弟子)"
              },
              {
                  "mention": "青藏高原",
                  "offset": 4,
                  "entity_title": "青藏高原(李娜演唱歌曲)"
              }
          ]
      }
      
    • 失败响应示例
      {
          "error_code": "NLP.0301",
          "error_msg": "argument valid error:text.text for entity-linking should between 1 and 50;"
      }

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

close