1. 接口描述
接口请求域名: nlp.tencentcloudapi.com 。
基于大数据和深度学习技术,可以快速地找到与给定词语高度相似的其他词语,有助于提高搜索和推荐的准确性。(目前仅支持中文)
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RetrieveSimilarWords。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Text | 是 | String | 输入的词语。(仅支持UTF-8格式,不超过10字符) |
Number | 是 | Integer | 召回的相似词个数,取值范围为1-20。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
WordList | Array of String | 召回的相似词数组。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 相似词召回调用示例
相似词召回
输入示例
POST / HTTP/1.1
Host: nlp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action:RetrieveSimilarWords
<公共请求参数>
{
"Text": "林丹",
"Number": 10
}
输出示例
{
"Response": {
"RequestId": "e246e84f-de88-46d0-b5dd-68ff94db40ad",
"WordList": [
"李宗伟",
"桃田贤斗",
"马龙",
"纳达尔",
"刘翔",
"张本智和",
"费德勒",
"孙杨",
"宁泽涛",
"朱婷"
]
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.BalanceInsufficient | 余额不足,开通失败,请充值后再开通。 |
FailedOperation.InnerError | 服务内部错误,请重试。 |
FailedOperation.NoResults | 暂无结果,请更换文本重试。 |
FailedOperation.NotFoundData | 未查询到结果。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.ResourceBusy | 服务器繁忙,请稍后再试。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
FailedOperation.UnKnowError | 内部错误。 |
FailedOperation.Unknown | 未知错误。 |
InternalError | 内部错误。 |
InternalError.ServiceCallError | 内部服务调用错误。 |
InternalError.ServiceError | 内部服务调用失败。 |
InvalidParameterValue.InvalidParameter | 参数不合法。 |
InvalidParameterValue.SensitiveText | Text输入含有敏感信息。 |
InvalidParameterValue.TextNumTooMuch | 输入文本超出数量限制 |
InvalidParameterValue.TextTooLong | 输入文本超出长度限制 |
LimitExceeded.ResourceReachedLimit | 资源用量达到上限。 |
ResourceInsufficient.QuotaRunOut | 额度用尽,请充值后重试 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable.Freeze | 账号已被冻结。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.IsOpening | 服务正在开通中,请稍等。 |
ResourceUnavailable.NotExist | 计费状态未知,请确认是否已在控制台开通服务。 |
ResourceUnavailable.Recover | 资源已被回收。 |
ResourceUnavailable.StopUsing | 账号已停服。 |
UnsupportedOperation.PkgExhausted | 资源包余量已用尽。 |