功能介绍

对文本进行命名实体识别分析，目前支持通用、商务和娱乐领域。

• 通用领域：支持人名、地名、组织机构、时间点、日期、百分比、货币额度、序数词、计量规格词、民族、职业、邮箱、国家、节日的实体的识别。
• 商务领域：支持公司名、品牌名、职业、职位、邮箱、手机号码、电话号码、IP地址、身份证号、网址、专业的实体的识别。
• 娱乐领域：支持电影名、动漫、书名、互联网、歌名、产品名、电视剧名、电视节目名的实体的识别。

具体Endpoint请参见终端节点。

调用华为云NLP服务会产生费用，套餐包分为基础版和领域版，购买时请在自然语言处理价格计算器中查看基础套餐包和领域套餐包支持的API范围。

URI

• URI格式

  POST /v1/{project_id}/nlp-fundamental/ner/domain

• 参数说明

  表1 URI参数说明

  参数名	必选	说明
  project_id	是	项目编号。获取方法，请参见获取项目ID。

请求消息

请求参数如表2所示。

响应消息

响应参数如表3所示。

示例1

• 请求示例

  POST https://{endpoint}/v1/{project_id}/nlp-fundamental/ner/domain
  
  Request Header:
      Content-Type: application/json
      X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  
  Request Body:
      {
          "text":"昨天程序员李小明来到北京参加开发者大赛，在比赛中表现优异，赢得了第一名。",
          "lang":"zh",
          "domain":"general"
      }

• 响应示例
  • 成功响应示例

    {
        "named_entities": [
            {
                "len": 2,
                "offset": 0,
                "tag": "day",
                "word": "昨天"
            },
            {
                "len": 3,
                "offset": 2,
                "tag": "job",
                "word": "程序员"
            },
            {
                "len": 3,
                "offset": 5,
                "tag": "nr",
                "word": "李小明"
            },
            {
                "len": 2,
                "offset": 10,
                "tag": "ns",
                "word": "北京"
            },
            {
                "len": 2,
                "offset": 32,
                "tag": "ord",
                "word": "第一"
            }
        ]
    }

  • 失败响应示例

    {
        "error_code": "NLP.0301",
        "error_msg": "The length of text should be in the range of 1-512."
    }

示例2

• 请求示例

  POST https://{endpoint}/v1/{project_id}/nlp-fundamental/ner/domain
  
  Request Header:
      Content-Type: application/json
      X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  
  Request Body:
      {
          "text":"程序员小明是华为的员工，邮箱是xiaoming@xx.com，电话12345678。",
          "lang":"zh",
          "domain":"business"
      }

• 响应示例
  • 成功响应示例

    {
        "named_entities": [
            {
                "len": 3,
                "offset": 0,
                "tag": "job",
                "word": "程序员"
            },
            {
                "len": 2,
                "offset": 6,
                "tag": "com",
                "word": "华为"
            },
            {
                "len": 15,
                "offset": 15,
                "tag": "email",
                "word": "xiaoming@xx.com"
            },
            {
                "len": 8,
                "offset": 33,
                "tag": "tele",
                "word": "12345678"
            }
        ]
    }

  • 失败响应示例

    {
        "error_code": "NLP.0301",
        "error_msg": "The length of text should be in the range of 1-512."
    }

示例3

• 请求示例

  POST https://{endpoint}/v1/{project_id}/nlp-fundamental/ner/domain
  
  Request Header:
      Content-Type: application/json
      X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  
  Request Body:
      {
          "text":"我早上看了动画《海贼王》，下午学唱《童年》，晚上在安徽卫视看《甄嬛传》。",
          "lang":"zh",
          "domain":"entertainment"
      }

• 响应示例
  • 成功响应示例

    {
        "named_entities": [
            {
                "len": 3,
                "offset": 8,
                "tag": "anime",
                "word": "海贼王"
            },
            {
                "len": 2,
                "offset": 18,
                "tag": "song",
                "word": "童年"
            },
            {
                "len": 4,
                "offset": 25,
                "tag": "pro",
                "word": "安徽卫视"
            },
            {
                "len": 3,
                "offset": 31,
                "tag": "dra",
                "word": "甄嬛传"
            }
        ]
    }

  • 失败响应示例

    {
        "error_code": "NLP.0301",
        "error_msg": "The length of text should be in the range of 1-512."
    }

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。