1. 接口描述
此接口处于预下线状态 。
预计下线时间:2023-08-03 15:12:10
接口请求域名: nlp.tencentcloudapi.com 。
因业务调整该接口将于北京时间2023年8月1日0点下线,届时该产品功能将无法正常使用,为了避免对您的业务造成影响,请您尽快做好相关业务调整。详见:https://cloud.tencent.com/document/product/271/90711
基于关键词提取平台,通过对文本内容进行深度分析,提取出文本内容中的关键信息,为用户实现诸如新闻内容关键词自动提取、评论关键词提取等提供基础服务。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:KeywordsExtraction。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Text | 是 | String | 待处理的文本(仅支持UTF-8格式,不超过10000字符) |
Num | 否 | Integer | 指定关键词个数上限(默认值为5) |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Keywords | Array of Keyword | 关键词提取结果 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 关键词提取示例
输入示例
POST / HTTP/1.1
Host: nlp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: KeywordsExtraction
<公共请求参数>
{
"Text": "印发《关于促进中小企业健康发展的指导意见》《改革国有资本授权经营体制方案》;启动第四批国企混合所有制改革试点,推进石油天然气电力等重点领域改革;颁布《外商投资法》,着手压减外商投资负面清单;设立科创板及试点注册制……今年以来,我国进一步放宽市场准入,继续削减行政审批和许可事项,使市场机制更加灵活、市场竞争更加公平,市场在资源配置中的决定性作用进一步发挥。",
"Num": 6
}
输出示例
{
"Response": {
"Keywords": [
{
"Score": 1,
"Word": "改革"
},
{
"Score": 0.71901304,
"Word": "外商投资"
},
{
"Score": 0.71288997,
"Word": "市场竞争"
},
{
"Score": 0.7022306,
"Word": "经营"
},
{
"Score": 0.69770753,
"Word": "市场机制"
},
{
"Score": 0.6859139,
"Word": "事项"
}
],
"RequestId": "669b5a3b-f159-42ea-8ac8-13b41557227c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.InvalidAuthorization | 请求头部的 Authorization 不符合腾讯云标准。 |
FailedOperation.IllegalTextError | 非法文本输入导致返回异常 |
InternalError | 内部错误。 |
InvalidParameterValue.EmptyValueError | 参数空值错误 |
InvalidParameterValue.TextEncodeError | 文本编码错误,不符合utf-8 |
InvalidParameterValue.TextFormatError | 文本输入格式错误 |
InvalidParameterValue.TextTooLong | 输入文本超出长度限制 |
InvalidParameterValue.ValueRangeError | 参数取值范围错误 |
ResourceInsufficient.QuotaRunOut | 额度用尽,请充值后重试 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.ServiceNotOpenedError | 您的账号尚未开通NLP服务,请登录腾讯云NLP控制台进行服务开通后再使用 |
UnauthorizedOperation.AuthenticateFailed | 实名认证失败 |