4.1 自然语言处理基础服务接口说明
4.1.10 关键词抽取
功能介绍
根据指定文本,抽取其中最能够反映文本主题或者意思的词汇。
具体Endpoint请参见终端节点。
调用华为云NLP服务会产生费用,本API支持使用基础套餐包,购买时请在自然语言处
理价格计算器中查看基础套餐包和领域套餐包支持的API范围。
调试
您可以在API Explorer中调试该接口。
前提条件
在使用本API之前,需要您完成服务申请和认证鉴权,具体操作流程请参见申请服务和
认证鉴权章节。
说明
用户首次使用需要先申请开通。服务只需要开通一次即可,后面使用时无需再次申请。如未开通 服务,调用服务时会提示ModelArts.4204报错,请在调用服务前先进入控制台开通服务,并注 意开通服务区域与调用服务的区域保持一致。
URI
● URI格式
POST /v1/{project_id}/nlp-fundamental/keyword-extraction
● 参数说明
表4-38 URI 参数说明
参数名 必选 说明
project_id 是 项目编号。获取方法,请参见获取项目ID。
请求消息
请求参数如表 请求参数所示。
表4-39 请求参数
参数名 参数类型 必选 说明
text String 是 待分析文本,长度为1~512,文本编码 为UTF-8。
limit int 否 返回关键词的最大数量,默认为5。
如果请求文本的词汇数量小于该值,则 返回实际词汇数量。
如果词汇数量为浮点数,则limit取该 浮点数向下取整的结果。
lang String 否 支持的文本语言类型,目前只支持中文
(zh),默认为中文。
响应消息
响应参数如表4-40所示。
表4-40 响应参数
参数名 参数类型 说明
words Array of String 关键词列表。
error_code String 调用失败时的错误码,具体参见错误
码。
调用成功时无此字段。
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
示例
● 请求示例
POST https://{endpoint}/v1/{project_id}/nlp-fundamental/keyword-extraction Request Header:
Content-Type: application/json X-Auth-Token:
MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
Request Body:
{
"text": "华为技术有限公司成立于1987年,总部位于广东省深圳市龙岗区。华为是全球领先的信息与通 信技术(ICT)解决方案供应商,专注于ICT领域,坚持稳健经营、持续创新、开放合作,在电信运营商、企 业、终端和云计算等领域构筑了端到端的解决方案优势,为运营商客户、企业客户和消费者提供有竞争力 的ICT解决方案、产品和服务,并致力于实现未来信息社会、构建更美好的全联接世界。",
"limit": 8, "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/keyword-extraction' # endpoint和 project_id需替换
resp = requests.post(url, data=json.dumps(body), headers=header) print(resp.text)
if __name__ == '__main__':
nlp_demo() */public class NLPDemo {
public void nlpDemo() { try {
//endpoint和projectId需要替换成实际信息。
URL url = new URL("https://{endpoint}/v1/{project_id}/nlp-fundamental/keyword-extraction");
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);
//输入参数
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()) {
public static void main(String[] args) { NLPDemo nlpDemo = new NLPDemo();
nlpDemo.nlpDemo();
} }
● 响应示例
– 成功响应示例
{ "words": [ "解决方案", "ICT", "信息", "企业", "领域", "技术", "运营商", "华为"
] }
– 失败响应示例
{ "error_code": "NLP.0301",
"error_msg": "argument valid error:lang.only support language:zh;"
}
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。