文档首页> 知识图谱 KG> API参考> API> 执行知识图谱查询命令
更新时间:2021-10-15 GMT+08:00
分享

执行知识图谱查询命令

功能介绍

指定知识图谱实例ID,在ID对应的知识图谱后端执行gremlin查询命令。gremlin命令仅限于读取操作,禁止执行修改操作。

URI

POST /v1/{project_id}/kg/kg-instances/{kg_id}/gremlin-query

表1 路径参数

参数

是否必选

参数类型

描述

kg_id

String

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

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

command

String

需要执行的gremlin查询语句,只能执行与查询功能相关的语句,不能执行修改图谱相关功能的语句。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

data

GremlinQueryRespData object

查询结果。请求失败时,字段为空。

表4 GremlinQueryRespData

参数

参数类型

描述

edges

Array of edges objects

关系查询结果。

runtime

Double

命令执行时间,单位为秒。

vertices

Array of vertices objects

实体查询结果。

results

Array of objects

该gremlin语句非常规格式的返回结果。

path

Array of pathItem objects

路径查询结果,为组成该路径的一系列关系的集合。

表5 edges

参数

参数类型

描述

id

String

关系ID,格式为“source(头实体ID)-target(尾实体ID)-index(关系索引值)”,如“4730302-1963128-1”,表示ID为4730302的实体和ID为1963128的实体之间的第1个关系。

index

String

关系的索引值,标识该条关系是其头尾实体的第几个关系。

label

String

关系的类型。

source

String

关系头实体ID。

target

String

关系尾实体ID。

表6 vertices

参数

参数类型

描述

id

String

实体ID。

label

String

实体类型。

properties

Map<String,Array<String>>

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

表7 pathItem

参数

参数类型

描述

id

String

关系ID,格式为“source(头实体ID)-target(尾实体ID)-index(关系索引值)”,如“4730302-1963128-1”,表示ID为4730302的实体和ID为1963128的实体之间的第1个关系。

index

Integer

关系的索引值,标识该条关系是其头尾实体的第几个关系。

source

Integer

关系头实体ID。

target

String

关系尾实体ID。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

https://nlp-ext.cn-north-4.myhuaweicloud.com/v1/1604d8170cd84440a81281e5a3a04f8b/kg/kg-instances/1bdb40b6-dc3a-4ed3-b90c-376dafc185a0/gremlin-query

{
  "command" : "g.V().limit(1)"
}

响应示例

状态码: 200

OK

{
  "data" : {
    "vertices" : [ {
      "id" : "9070097808196707553",
      "label" : "电影",
      "properties" : {
        "上映时间" : [ "1958年1月16日" ],
        "name" : [ "保卫和平" ],
        "票房" : [ "39.04亿" ]
      }
    } ],
    "runtime" : 0.02850004
  }
}

状态码: 400

Bad Request

{
  "error_code" : "KGP.2003",
  "error_msg" : "Gremlin query return error"
}

状态码: 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

错误码

请参见错误码

分享:

    相关文档

    相关产品

close