文档首页> 知识图谱 KG> API参考> API> 过滤查询实体列表
更新时间:2021-10-15 GMT+08:00
分享

过滤查询实体列表

功能介绍

根据图谱ID,过滤查看满足指定条件的实体列表,列表信息包括实体ID、实体类型、实体属性及其属性值。

URI

POST /v1/{project_id}/kg/kg-instances/{kg_id}/entities/property-query

表1 路径参数

参数

是否必选

参数类型

描述

kg_id

String

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

project_id

String

用户项目ID。获取方法请参见获取项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

labels

Array of strings

实体类型列表。

offset

Integer

翻页偏移量,默认为0。

limit

Integer

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

conditions

conditions object

过滤查询条件。

condition_type

String

筛选条件之间的逻辑关系。

缺省值:and

枚举值:

  • and

  • or

表3 conditions

参数

是否必选

参数类型

描述

property_name

String

属性名称。

property_value

Array of strings

属性值,目前只支持设置一个属性值。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

当前返回的实体结果个数。

results

Array of EntityDetailResp objects

符合过滤条件的实体列表。

表5 EntityDetailResp

参数

参数类型

描述

id

String

实体ID。

label

String

实体类型。

properties

Map<String,Array<String>>

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

请求示例

https://nlp-ext.cn-north-4.myhuaweicloud.com/v1/1604d8170cd84440a81281e5a3a04f8b/kg/kg-instances/6cdcea01-bac0-48f6-acb5-9385ea3e24ad/entities/property-query

{
  "labels" : [ "电影" ],
  "offset" : 0,
  "limit" : 1,
  "conditions" : [ {
    "property_name" : "name",
    "property_values" : [ "一条牧羊犬" ]
  } ]
}

响应示例

状态码: 200

OK

{
  "count" : 1,
  "entities" : [ {
    "id" : "-8886811463068384992",
    "label" : "电影",
    "properties" : {
      "上映时间" : [ "1982年4月22日" ],
      "name" : [ "一条牧羊犬" ],
      "票房" : [ "34.72亿" ]
    }
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品

close