实体关系查询

最近更新时间:2019-11-21 19:38:16

1. 接口描述

接口请求域名: nlp.tencentcloudapi.com 。

输入两个实体,返回两个实体间的关系,例如马化腾与腾讯公司不仅是相关实体,二者还存在隶属关系(马化腾属于腾讯公司)。

默认接口请求频率限制:30次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRelation
Version String 公共参数,本接口取值:2019-04-08
Region String 公共参数,详见产品支持的 地域列表
LeftEntityName String 输入第一个实体
RightEntityName String 输入第二个实体

3. 输出参数

参数名称 类型 描述
Content Array of EntityRelationContent 返回查询实体间的关系
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 实体关系查询

给定两个实体的名称,查询两个实体的边关系。常用于个性化推荐、搜索,智能问答等业务场景。

输入示例

https://nlp.tencentcloudapi.com/?Action=DescribeRelation
&LeftEntityName=广东省
&RightEntityName=深圳市
&<公共请求参数>

输出示例

{
  "Response": {
    "Content": [
      {
        "Object": [
          {
            "Id": [
              "6b989d08-ecc5-4695-8857-5a5780c7bda1"
            ],
            "Name": [
              "深圳"
            ],
            "Popular": [
              900
            ]
          }
        ],
        "Relation": "下辖地区",
        "Subject": [
          {
            "Id": [
              "b7d24d73-621a-4fdc-af5b-0c6e69a2c12f"
            ],
            "Name": [
              "广东"
            ],
            "Popular": [
              902
            ]
          }
        ]
      },
      {
        "Object": [
          {
            "Id": [
              "6b989d08-ecc5-4695-8857-5a5780c7bda1"
            ],
            "Name": [
              "深圳"
            ],
            "Popular": [
              900
            ]
          }
        ],
        "Relation": "相关实体",
        "Subject": [
          {
            "Id": [
              "b7d24d73-621a-4fdc-af5b-0c6e69a2c12f"
            ],
            "Name": [
              "广东"
            ],
            "Popular": [
              902
            ]
          }
        ]
      }
    ],
    "RequestId": "0e113f49-853d-4ab1-af86-f504a47c68a1"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InternalError.ExternalServiceError 外部服务调用失败
InternalError.GraphEngineError 图数据库引擎内部错误
InternalError.GremlinTimeoutError 图查询引擎计算超时错误
InternalError.RequestEncodeError 请求数据解析失败
InternalError.RequestParseError 读取请求数据内容失败
InternalError.ResponseDecodeError 系统响应解析失败
InvalidParameter 参数错误
InvalidParameter.InvalidAction 接口不存在
InvalidParameter.InvalidActionError 不可用的接口操作错误
InvalidParameterValue 参数取值错误
InvalidParameterValue.EmptyValueError 参数空值错误
InvalidParameterValue.ValueRangeError 参数取值范围错误
MissingParameter 缺少参数错误
ResourceInUse 资源被占用
ResourceInsufficient 资源不足
ResourceInsufficient.QuotaRunOut 额度用尽,请充值后重试
ResourceUnavailable 资源不可用
UnauthorizedOperation 未授权操作