1. 接口描述
接口请求域名: nlp.tencentcloudapi.com 。
相似词接口能够基于同义词库及词向量技术,检索出与输入词语在语义上最相似的若干个词语,可广泛用于检索系统、问答系统、文档归档等场景。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SimilarWords。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Text | 是 | String | 输入的词语(仅支持UTF-8格式,不超过20字) |
WordNumber | 否 | Integer | 相似词个数;取值范围:1-200,默认为10; |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SimilarWords | Array of String | 相似词数组 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 相似词示例
输入示例
https://nlp.tencentcloudapi.com/?Action=SimilarWords
&Text="腾讯"
&WordNumber=20
&<公共请求参数>
输出示例
{
"Response": {
"SimilarWords": [
"腾迅",
"腾讯网",
"腾讯公司",
"搜狐",
"网易",
"新浪",
"中华网",
"QQ",
"和讯网",
"17173",
"搜搜",
"优酷网",
"拍拍网",
"SINA",
"酷讯",
"海网",
"空中网",
"奇虎",
"Qzone",
"猫扑网"
],
"RequestId": "8dd99adb-5144-43ca-8213-f6a929ce5075"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.WordNotFound | 查找不到词语 |
InvalidParameterValue.EmptyValueError | 参数空值错误 |
InvalidParameterValue.TextEncodeError | 文本编码错误,不符合utf-8 |
InvalidParameterValue.TextTooLong | 输入文本超出长度限制 |
InvalidParameterValue.ValueRangeError | 参数取值范围错误 |
ResourceInsufficient.QuotaRunOut | 额度用尽,请充值后重试 |
ResourceUnavailable.ServiceNotOpenedError | 您的账号尚未开通NLP服务,请登录腾讯云NLP控制台进行服务开通后再使用 |
UnauthorizedOperation.AuthenticateFailed | 实名认证失败 |