1. 接口描述
接口请求域名: nlp.tencentcloudapi.com 。
此接口正在维护升级,后续上线另行通知。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
本文档展示的是V1签名的参数说明,腾讯云建议您使用安全系数更高的V3签名算法,使用签名方法 v3 时,公共参数需要统一放到 HTTP Header 请求头部中,详情。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeEntity。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
EntityName | 是 | String | 实体名称 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Content | String | 返回查询实体相关信息 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实体信息查询
给定实体的名称,查询实体的所有属性和属性值。常用于个性化推荐、搜索,智能问答等业务场景。
输入示例
https://nlp.tencentcloudapi.com/?Action=DescribeEntity
&EntityName=腾讯云
&<公共请求参数>
输出示例
{
"Response": {
"Content": "{\"Alias\":[{\"Name\":\"腾讯云\",\"Order\":0}],\"Extra\":[{\"Name\":\"腾讯云\"}],\"Foundin\":[{\"Name\":\"http://baike.baidu.com/item/%E8%85%BE%E8%AE%AF%E4%BA%91\"},{\"Name\":\"http://baike.baidu.com/item/%E8%85%BE%E8%AE%AF%E4%BA%91/9905046\"},{\"Name\":\"http://baike.baidu.com/view/10880522.htm\"},{\"Name\":\"https://baike.sogou.com/m/fullLemma?lid=66901919\"}],\"Id\":[{\"Name\":\"87bc7630-9ed9-4bf0-a3d6-363eeeac4e21\"}],\"ImageDigest\":[{\"Name\":\"1fbf6a63b562ce566635b09342ecd91a\",\"Order\":1000}],\"Name\":[{\"Name\":\"腾讯云\"}],\"Popular\":[{\"Name\":523}],\"Type\":[{\"Name\":\"科技产品类_产品 (174)\"}],\"Types\":[{\"Name\":174}],\"上位词\":[{\"Name\":\"用户体验\",\"Order\":1000},{\"Name\":\"应用系统\",\"Order\":1000},{\"Name\":\"网站\",\"Order\":1000},{\"Name\":\"数据中心\",\"Order\":1000},{\"Name\":\"社交\",\"Order\":1000},{\"Name\":\"平台\",\"Order\":1000},{\"Name\":\"解决方案\",\"Order\":1000},{\"Name\":\"互联网\",\"Order\":1000}],\"中文名\":[{\"Name\":\"腾讯云\",\"Order\":0}],\"使用领域\":[{\"Name\":\"社交\",\"Order\":0},{\"Name\":\"游戏和其他领域\",\"Order\":1}],\"原始名称\":[{\"Name\":\"腾讯云\",\"Order\":1}],\"名称\":[{\"Name\":\"腾讯云\",\"Order\":0}],\"外文名\":[{\"Name\":\"qcloud\",\"Order\":0}],\"应用\":[{\"Name\":\"云空间\",\"Order\":0}],\"搜狗简介\":[{\"Name\":\"腾讯云 有着深厚的基础架构,并且有着多年对海量互联网服务的经验,不管是社交、游戏还是其他领域,都有多年的成熟产品来提供产品服务。腾讯在云端完成重要部署,为开发者及企业提供云服务、云数据、云运营等整体一站式服务方案。 具体包括云服务器、云存储、云数据库和弹性web引擎等基础云服务;腾讯云分析(MTA)、腾讯云推送(信鸽)等腾讯整体大数据能力;以及 QQ互联、QQ空间、微云、微社区等云端链接社交体系。这些正是腾讯云可以提供给这个行业的差异化优势,造就了可支持各种互联网使用场景的高品质的腾讯云技术平台。 2018年12月24日,腾讯云宣布印度二区正式对外开放服务。该数据中心的开服,正式确立了腾讯云在南亚市场双可用区格局。\",\"Order\":1}],\"相关实体\":[{\"Id\":\"cb41b3d9-084d-47e9-a7c6-db9f34291e72\",\"Name\":\"云服务器\",\"Order\":1,\"Popular\":0},{\"Id\":\"f4ef5a26-5004-464c-b330-e00e240eb51a\",\"Name\":\"阿里云\",\"Order\":1,\"Popular\":0},{\"Id\":\"a8d63f3a-65af-49ef-84fc-b02e3fc85a8c\",\"Name\":\"行业解决方案\",\"Order\":1,\"Popular\":0},{\"Id\":\"a594c811-139c-4211-807b-3fe71da289ef\",\"Name\":\"云服务\",\"Order\":1,\"Popular\":0}],\"简介\":[{\"Name\":\"腾讯云有着深厚的基础架构,并且有着多年对海量互联网服务的经验,不管是社交、游戏还是其他领域,都有多年的成熟产品来提供产品服务。腾讯在云端完成重要部署,为开发者及企业提供云服务、云数据、云运营等整体一站式服务方案。|@|具体包括云服务器、云存储、云数据库和弹性web引擎等基础云服务;腾讯云分析(mta)、腾讯云推送(信鸽)等腾讯整体大数据能力;以及 qq互联、qq空间、微云、微社区等云端链接社交体系。这些正是腾讯云可以提供给这个行业的差异化优势,造就了可支持各种互联网使用场景的高品质的腾讯云技术平台。\",\"Order\":0}],\"类别\":[{\"Name\":\"互联网\",\"Order\":0}],\"精选上位词\":[{\"Name\":\"产品\",\"Order\":1},{\"Name\":\"成熟产品来提供产品服务\",\"Order\":1},{\"Name\":\"互联网\",\"Order\":1}],\"英文名\":[{\"Name\":\"qcloud\",\"Order\":0}]}",
"RequestId": "0e113f49-853d-4ab1-af86-f504a47c68a1"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InternalError.ExternalServiceError | 外部服务调用失败 |
InternalError.GraphEngineError | 图数据库引擎内部错误 |
InternalError.GremlinTimeoutError | 图查询引擎计算超时错误 |
InternalError.RequestEncodeError | 请求数据解析失败 |
InternalError.RequestParseError | 读取请求数据内容失败 |
InternalError.ResponseDecodeError | 系统响应解析失败 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidAction | 接口不存在 |
InvalidParameter.InvalidActionError | 不可用的接口操作错误 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.EmptyValueError | 参数空值错误 |
InvalidParameterValue.TextFormatError | 文本输入格式错误 |
InvalidParameterValue.ValueRangeError | 参数取值范围错误 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceInsufficient.QuotaRunOut | 额度用尽,请充值后重试 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.ServiceNotOpenedError | 您的账号尚未开通NLP服务,请登录腾讯云NLP控制台进行服务开通后再使用 |
UnauthorizedOperation | 未授权操作。 |