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

查询实体详情

功能介绍

根据图谱ID和实体ID查询实体详情，包括实体的ID、类型、属性及属性值。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

entity_id

是

String

实体ID。

kg_id

是

String

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

project_id

是

String

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

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

id

String

实体ID。

label

String

实体类型。

properties

Map<String,Array<String>>

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

状态码： 400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 403

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

无

响应示例

状态码： 200

OK

{
  "id" : "9062852764642362192",
  "label" : "电影",
  "properties" : {
    "上映时间" : [ "1952年9月13日" ],
    "name" : [ "大卫和麦克的故事" ],
    "票房" : [ "4.01亿" ]
  }
}

状态码： 400

Bad Request

{
  "error_code" : "KGP.2007",
  "error_msg" : "entity not found"
}

状态码： 403

Forbidden

{
  "error_code" : "KGP.0004",
  "error_msg" : "Auth failed"
}

状态码： 500

Internal Server Error

{
  "error_code" : "KGP.9001",
  "error_msg" : "Internal server error."
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： API

相关文档