文档首页/ 知识图谱 KG/ API参考/ API/ 查询关联实体
更新时间：2024-04-24 GMT+08:00
查看PDF
分享

查询关联实体

功能介绍

指定知识图谱实例ID，在ID对应的知识图谱后端，查询与指定实体有一跳关系的实体，返回满足条件的实体列表。

URI

GET /v1/{project_id}/kg/kg-instances/{kg_id}/entities/{entity_id}/adjacent-entities

表1 路径参数

参数

是否必选

参数类型

描述

entity_id

是

String

实体ID。

kg_id

是

String

知识图谱ID。在KG服务控制台“我的图谱”页面，单击图谱名称，进入图谱详情页左上角获取知识图谱ID。

project_id

是

String

用户项目ID。获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

label

否

String

具有一跳关系的实体类型。默认为空，即查询有一跳关系的所有类型的实体。 说明： N跳关系说明：如果从一个实体A出发，经过N条关系（不论方向），能够到达实体B，则实体A、B之间是N跳关系。 特别地，如果两个实体之间是一跳关系，说明两个实体之间通过一条关系直接相连。

limit

否

Integer

最大返回结果条数，默认为10，最大为100。

最小值：0

最大值：100

缺省值：10

offset

否

Integer

翻页偏移量，默认为0。

最小值：0

最大值：100

缺省值：0

relation_name

否

String

需要查询的关系名称。默认为空，即查询所有一跳关系。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

entity

EntityDetailResp object

中心实体详情。

results

AdjacentDetail object

关系列表。

total

Integer

与中心实体具有一跳关系的实体总数。

count

Integer

返回的实体数量。
表4 EntityDetailResp

参数

参数类型

描述

id

String

实体ID。

label

String

实体类型。

properties

Map<String,Array<String>>

实体各个属性值，格式为字典数据结构，键为该实体属性名，值为字符串列表，为该实体属性值。
表5 AdjacentDetail

参数

参数类型

描述

adjacent_entity_id

String

与中心实体具有一跳关系的实体ID。 说明： N跳关系说明：如果从一个实体A出发，经过N条关系（不论方向），能够到达实体B，则实体A、B之间是N跳关系。 特别地，如果两个实体之间是一跳关系，说明两个实体之间通过一条关系直接相连。

edge

AdjacentEdgeDetail object

关系详情。

direction

String

关系方向，枚举值，有OUT和IN两种，OUT表示出，IN表示指入。

枚举值：

  • IN
  • OUT
表6 AdjacentEdgeDetail

参数

参数类型

描述

relation_label

String

关系的类型。

source_id

String

关系的头实体ID。

target_id

String

关系的尾实体ID。

请求示例

查询关联实体，最多返回两条结果

https://nlp-ext.cn-north-4.myhuaweicloud.com/v1/1604d8170cd84440a81281e5a3a04f8b/kg/kg-instances/6cdcea01-bac0-48f6-acb5-9385ea3e24ad/entities/8039469283414000536/adjacent-entities?offset=0&limit=2

响应示例

状态码： 200

OK

{
  "entity" : {
    "id" : "8039469283414000536",
    "label" : "人物",
    "properties" : {
      "职业" : [ "演员，歌手" ],
      "出生日期" : [ "1980年12月13日" ],
      "name" : [ "计广" ],
      "国籍" : [ "中国" ]
    }
  },
  "results" : [ {
    "direction" : "IN",
    "adjacent_entity_id" : "8886811463068384992",
    "edge" : {
      "source_id" : "8886811463068384992",
      "target_id" : "8039469283414000536",
      "relation_label" : "主演",
      "properties" : null
    }
  }, {
    "direction" : "IN",
    "adjacent_entity_id" : "7146030181767445493",
    "edge" : {
      "source_id" : "7146030181767445493",
      "target_id" : "8039469283414000536",
      "relation_label" : "主演",
      "properties" : null
    }
  } ],
  "total" : 20,
  "count" : 2
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： API

相关文档