查询关联实体_知识图谱 KG_API参考_API_华为云

(1)

知识图谱

API 参考

文档版本 01

发布日期 2021-11-10

(2)

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

(3)

1 ^{使用前必读}

1.1 概述

欢迎使用知识图谱服务 (Knowledge Graph，简称KG) 。知识图谱是面向各类企业的一站式知识计算平台，提供本体管理、图谱管理、图谱构建等功能，帮助用户从0到1 快速构建知识图谱，管理知识图谱流水线任务。

在调用知识图谱服务API之前，请确保已经充分了解知识图谱服务相关概念，详细信息请参见产品介绍。

KG服务以开放API的方式提供给用户，您可以根据本文档提供的API使用服务，支持的全部API请参见API概览。

1.2 调用说明

知识图谱服务提供了REST（Representational State Transfer）风格API，支持您通过 HTTPS请求调用，调用方法请参见如何调用API。

1.3 终端节点

终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。

知识图谱服务的终端节点如表1-1所示，请您根据业务需要选择对应区域的终端节点。

表1-1 知识图谱的终端节点

区域名称区域终端节点（Endpoint）

华北-北京四 cn-north-4 nlp-ext.cn-north-4.myhuaweicloud.com

API 参考 1 使用前必读

(5)

1.4 约束与限制

● 您能创建的知识图谱服务器的数量与配额有关系，具体请参见服务配额。

● 更详细的限制请参见具体API的说明。

1.5 基本概念

● 帐号

用户注册华为云时的帐号，帐号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于帐号是付费主体，为了确保帐号安全，建议您不要直接使用帐号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。

● 用户

由帐号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。

在我的凭证下，您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中，您需要用到帐号、用户和密码等信息。

● 区域

指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。

● 可用区

一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

● 项目

华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。

图1-1 项目隔离模型

(6)

同样在我的凭证下，您可以查看项目ID。

● 企业项目

企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

(7)

2 ^{API 概览}

KG服务提供接口请参见表2-1，您可以使用知识图谱数据面管理功能。

表2-1 知识图谱数据面接口

API 说明

执行知识图谱查

询命令根据图谱ID执行知识图谱查询命令。

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

及属性值。

过滤查询实体列

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

查询关联实体根据图谱ID和关系类型查询与某一实体有关系的实体。

进行KBQA会话进行KBQA问答会话。

实体链接对用户文本进行分析，识别出其中的实体，并返回图谱中关联节点的信息。

知识搜索对用户文本进行分析，对图谱中的相关知识进行搜索。

知识推荐根据输入的实体节点，推荐相关的实体节点。

API 参考 2 API 概览

(8)

3 ^{如何调用 API}

3.1 构造请求

本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token接口说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。

您还可以通过视频教程了解如何构造请求调用API 。

请求 URI

请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

● URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。

● Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的 Endpoint不同，您可以从地区和终端节点中获取终端节点。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。

● resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如

“获取用户Token”API的resource-path为“/v3/auth/tokens”。

● query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数 前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。

https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

API 参考 3 如何调用 API

(9)

图3-1 URI 示意图

说明

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。

这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。

● GET：请求服务器返回指定资源。

● PUT：请求服务器更新指定资源。

● POST：请求服务器新增资源或执行特殊操作。

● DELETE：请求服务器删除指定资源，如删除对象等。

● HEAD：请求服务器资源头部。

● PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会 去创建一个新的资源。

在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。

如下公共消息头需要添加到请求中。

● Content-Type：消息体的类型（格式），必选，默认取值为“application/

json”，有其他取值时会在具体接口中专门说明。

● X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字 段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

说明

公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。

AK/SK认证的详细说明请参见AK/SK认证。

● X-Project-ID：子项目ID，可选，在多项目场景中使用。

● X-Domain-ID：帐号ID。

(10)

对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体

请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中

username

为用户名，

domainname

为用户所属的帐号名称，

********

为用户登录密码，

xxxxxxxxxxxxxxxxxx

为project的ID，获取方法请参见获取项目ID。

说明

scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个帐号下所有资源或帐号的某个project下的资源，详细定义请参见获取用户Token。

{ "auth": { "identity": { "methods": [ "password"

],

"password": { "user": {

"name": "username", "password": "********", "domain": {

"name": "domainname"

} } } }, "scope": { "project": {

"id": "xxxxxxxxxxxxxxxxxx"

} } } }

到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x- subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

3.2 认证鉴权

调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。

(11)

● Token认证：通过Token认证通用请求。

● AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。

Token 认证

说明

Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。

Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。

Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的 Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择 project，如下所示。

获取用户Token接口请求构造如下，您可以从接口的请求部分看到所需的请求参数及参数说明。获取Token消息头只需填写“Content-Type”。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中

usernam用户名

，

domainname

为用户所属的帐号名称，

********

为用户登录密码。

获取Token的终端节点和

projectname

需与KG服务终端节点保持一致。当访问华北-北京四的终端节点（即nlp-ext.

cn-north-4

.myhuaweicloud.com时），获取Token请使用终端节点https://iam.

cn-north-4

.myhuaweicloud.com，

projectname

对应使用

cn- north-4

。

{ "auth": { "identity": { "methods": [ "password"

],

"password": { "user": {

"name": "username", "password": "********", "domain": {

"name": "domainname"

} } } }, "scope": { "project": {

"name": "xxxxxxxx"

} } } }

获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，

其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token:

ABCDEFJ....”加到请求消息头即可，如下所示。

GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json

X-Auth-Token: ABCDEFJ....

您还可以通过视频教程了解如何使用Token认证。

(12)

AK/SK 认证

如需使用AK/SK认证，请使用下文签名SDK。

说明

AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用Token认证。

AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。

● AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥 ID和私有访问密钥一起使用，对请求进行加密签名。

● SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，

可标识发送方，并防止请求被修改。

使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。

如果之前没有生成过AK/SK，可登录华为云“我的凭证”界面，选择“管理访问秘钥>

新增访问秘钥”来获取。

须知

签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

AK/SK获取方式请参考获取AK/SK。

3.3 返回结果

状态码

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。

对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

对于获取用户Token接口，返回如图3-2所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

(13)

图3-2 获取用户 Token 响应消息头

响应消息体

响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。

对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

{ "token": {

"expires_at": "2019-02-13T06:52:13.855000Z", "methods": [

"password"

],

"catalog": [ {

"endpoints": [ {

"region_id": "cn-north-1", ...

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

{ "error_msg": "The format of message is error", "error_code": "AS.0001"

}

其中，error_code表示错误码，error_msg表示错误描述信息。

(14)

4 ^API

4.1 执行知识图谱查询命令

功能介绍

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

URI

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

表4-1 路径参数

参数是否必选参数类型描述

kg_id 是 String 知识图谱ID。在KG服务控制台

“我的图谱”页面，单击图谱名称，进入图谱详情页左上角获取知识图谱ID。

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

请求参数

表4-2 请求 Body 参数

command 是 String 需要执行的gremlin查询语句，

只能执行与查询功能相关的语句，不能执行修改图谱相关功能的语句。

API 参考 4 API

(15)

响应参数

状态码： 200

表4-3 响应 Body 参数

参数参数类型描述

data GremlinQuer yRespData object

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

表4-4 GremlinQueryRespData

edges Array of

edges objects 关系查询结果。

runtime Double 命令执行时间，单位为秒。

vertices Array of vertices objects

实体查询结果。

results Array of

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

path Array of pathItem objects

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

表4-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。

API 参考 4 API

(16)

表4-6 vertices

id String 实体ID。

label String 实体类型。

properties Map<String,A

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

表4-7 pathItem

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

source Integer 关系头实体ID。

状态码： 400

error_code String 错误码 error_msg String 错误信息

状态码： 403

状态码： 500

API 参考 4 API

(17)

请求示例

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_msg" : "Internal server error."

}

API 参考 4 API

(18)

状态码

状态码描述 200 OK

400 Bad Request 403 Forbidden

500 Internal Server Error

错误码

请参见错误码。

4.2 查询实体详情

功能介绍

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

URI

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

表4-11 路径参数

entity_id 是 String 实体ID。

请求参数

无

响应参数

状态码： 200

API 参考 4 API

(19)

状态码： 400

状态码： 403

状态码： 500

请求示例

无

API 参考 4 API

(20)

响应示例

状态码： 200 OK

{ "id" : "9062852764642362192", "label" : "电影",

"properties" : {

"上映时间" : [ "1952年9月13日" ], "name" : [ "大卫和麦克的故事" ], "票房" : [ "4.01亿" ]

}}

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

}

状态码

错误码

API 参考 4 API

(21)

4.3 过滤查询实体列表

功能介绍

根据图谱ID，过滤查看满足指定条件的实体列表，列表信息包括实体ID、实体类型、

实体属性及其属性值。

URI

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

表4-16 路径参数

请求参数

labels 否 Array of

strings 实体类型列表。

offset 否 Integer 翻页偏移量，默认为0。

limit 否 Integer 最大返回结果条数，默认为

10，最大为100。

conditions 是 conditions

object 过滤查询条件。

condition_typ

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

缺省值：and 枚举值：

● and

● or

API 参考 4 API

(22)

表4-18 conditions

property_nam

e 否 String 属性名称。

property_valu

e 否 Array of

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

响应参数

状态码： 200

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

results Array of EntityDetailR esp objects

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

表4-20 EntityDetailResp

请求示例

6cdcea01-bac0-48f6-acb5-9385ea3e24ad/entities/property-query { "labels" : [ "电影" ],

"offset" : 0, "limit" : 1, "conditions" : [ {

"property_name" : "name", "property_values" : [ "一条牧羊犬" ] } ]

}

API 参考 4 API

(23)

响应示例

状态码： 200 OK

{ "count" : 1, "entities" : [ {

"id" : "-8886811463068384992", "label" : "电影",

"properties" : {

"上映时间" : [ "1982年4月22日" ], "name" : [ "一条牧羊犬" ], "票房" : [ "34.72亿" ] }

} ] }

状态码

错误码

4.4 查询关联实体

功能介绍

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

URI

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

表4-21 路径参数

entity_id 是 String 实体ID。

API 参考 4 API

(24)

表4-22 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

entity EntityDetailR

esp object 中心实体详情。

results AdjacentDeta

il object 关系列表。

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

count Integer 返回的实体数量。

API 参考 4 API

(25)

表4-24 EntityDetailResp

表4-25 AdjacentDetail

adjacent_entit

y_id String 与中心实体具有一跳关系的实体ID。说明： N跳关系说明：如果从一个实体A出发，经过N条关系

（不论方向），能够到达实体B，则实体A、B之间是N跳关系。特别地，如果两个实体之间是一跳关系，说明两个实体之间通过一条关系直接相连。

edge AdjacentEdg

eDetail object 关系详情。

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

枚举值：

● IN

● OUT

表4-26 AdjacentEdgeDetail

relation_label String 关系的类型。

source_id String 关系的头实体ID。

target_id String 关系的尾实体ID。

请求示例

6cdcea01-bac0-48f6-acb5-9385ea3e24ad/entities/8039469283414000536/adjacent-entities?offset=0&limit=2

响应示例

状态码： 200

API 参考 4 API

(26)

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 }

状态码

错误码

4.5 进行 KBQA 会话

功能介绍

知识图谱问答服务（Knowledge Base Question Answering，简称KBQA）利用机器对自然语言分析与处理能力，理解用户所提出的问题，并利用知识图谱中的结构化知识进行查询、推理，找到解决该问题的精准答案并反馈给用户，协助用户解决不同类型的问题。

URI

POST /v1/{project_id}/kg/kg-instances/{kg_id}/apps/kbqa/converse

API 参考 4 API

(27)

表4-27 路径参数

请求参数

query 是 String 用户的提问内容，中文英文及中

英文标点符号，长度限制为1-50 个字符。

session_id 否 String KBQA会话ID。如不携带或为过期、无效ID，则自动创建新的会话并返回会话ID。

响应参数

状态码： 200

answer String 系统返回的答案。

session_id String 本次会话的ID。若请求体中已携带有效会话ID，

则与请求体中相同，否则为新会话ID。

frame Array of KBQARespFr ame objects

系统查询答案时使用的查询语句执行信息。

表4-30 KBQARespFrame

formatted_qu

estion String 用户问题对应的解析，即格式化后的问题。

API 参考 4 API

(28)

match_type String 用户问题对应的匹配模板的类型，取值：系统内置模板（SYS_TEMPLATE）。

template_id String 用户问题对应的匹配模板的ID。

template_na

me String 用户问题对应的匹配模板的名称。

template_scor

e Double 匹配模板对应的匹配得分。

query String 系统查询答案时使用的查询语句。

result GremlinQuer yRespData object

查询语句对应的查询结果。

answer String 查询语句对应的答案文本。

表4-31 GremlinQueryRespData

edges Array of

edges objects 关系查询结果。

runtime Double 命令执行时间，单位为秒。

vertices Array of vertices objects

实体查询结果。

results Array of

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

path Array of pathItem objects

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

表4-32 edges

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

API 参考 4 API

(29)

label String 关系的类型。

source String 关系头实体ID。

表4-33 vertices

表4-34 pathItem

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

source Integer 关系头实体ID。

请求示例

6cdcea01-bac0-48f6-acb5-9385ea3e24ad/apps/kbqa/converse { "session_id" : "b22ce1e7-72e6-4846-86e5-65f66a882989", "query" : "小明的身高"

}

响应示例

状态码： 200 OK

{ "answer" : "小明的身高是175cm。",

API 参考 4 API

(30)

"session_id" : "b22ce1e7-72e6-4846-86e5-65f66a882989", "frame" : [ {

"formatted_question" : "[小明]的[身高]", "match_type" : "SYS_TEMPLATE",

"template_id" : "77396e46-6eec-49bb-bb84-84faa4229090", "template_name" : "xx实体的xx属性",

"template_score" : 1.0,

"query" : "g.V('6155801785020056890').valueMap('name', '身高').path()", "result" : {

"vertices" : [ {

"id" : "6155801785020056890", "label" : "人物"

} ],

"runtime" : 0.007594787999999999, "results" : [ {

"name" : [ "小明" ], "身高" : [ "175cm" ] } ]

},

"answer" : "小明的身高是175cm。"

} ] }

{ "error_code" : "KGP.2007", "error_msg" : "kg not found"

}

状态码

错误码

4.6 实体链接

功能介绍

对用户文本进行分析，识别出其中的实体，并返回图谱中关联节点的信息。

API 参考 4 API

(31)

URI

POST /v1/{project_id}/kg/kg-instances/{kg_id}/apps/entity-linking

表4-35 路径参数

请求参数

text 是 String 用户输入文本，长度限制为1-50

个字符。

最小长度：1 最大长度：50

响应参数

状态码： 200

entities Array of EntityLinking RespEntityM ention objects

实体链接结果。

表4-38 EntityLinkingRespEntityMention

entity_id String 链接到的图谱节点对应的实体id。

API 参考 4 API

(32)

entity_title String 链接到的图谱节点对应的实体名称。

mention String 实体名称。

offset Integer 实体文本在待分析文本中的起始位置。

请求示例

6cdcea01-bac0-48f6-acb5-9385ea3e24ad/apps/entity-linking { "text" : "李娜唱的青藏高原真好听"

}

响应示例

状态码： 200 OK

{ "entities" : [ { "mention" : "李娜", "offset" : 0,

"entity_id" : "6939670486880563336", "entity_title" : "李娜（流行歌手、佛门女弟子）"

}, {

"mention" : "青藏高原", "offset" : 4,

"entity_id" : "8654144631589645401", "entity_title" : "青藏高原（李娜演唱歌曲）"

} ] }

{ "error_code" : "KGP.2007", "error_msg" : "kg not found"

}

状态码

API 参考 4 API

(33)

状态码描述

错误码

4.7 知识搜索

功能介绍

对用户文本进行分析，对图谱中的相关知识进行搜索。

URI

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

表4-39 路径参数

请求参数

query 是 String 用户搜索的语句。

limit 否 Integer 限制返回的数量，默认为10。

最小值：1 最大值：100

API 参考 4 API

(34)

响应参数

状态码： 200

total Integer 搜索结果个数。

entites KgSearchRes pEntities object

搜索结果详情。

表4-42 KgSearchRespEntities

name String 实体的名称。

properties Map<String,St

ring> 实体的属性及属性值。

score Integer 关联度得分，作为参考，分值越高关联程度越大。

状态码： 400

状态码： 403

API 参考 4 API

(35)

状态码： 500

请求示例

6cdcea01-bac0-48f6-acb5-9385ea3e24ad/apps/query { "query" : "不止英雄的票房",

"limit" : 100 }

响应示例

状态码： 200 OK

{ "total" : 2, "entities" : [ { "name" : "不止英雄", "score" : 1,

"id" : "6751625866271911141", "label" : "电影",

"properties" : { "票房" : "19.50亿"

} }, {

"name" : "乱世出英雄", "score" : 0.137613,

"id" : "4861731593422907967", "label" : "电影",

"properties" : {

"上映时间" : "1965年1月4日", "票房" : "5.40亿"

} } ] }

{ "error_code" : "KGP.2001", "error_msg" : "Kg not found"

}

API 参考 4 API

(36)

"error_msg" : "Auth failed"

}

状态码

错误码

4.8 知识推荐

功能介绍

根据输入的实体信息或文本，推荐相关的实体。

URI

POST /v1/{project_id}/kg/kg-instances/{kg_id}/apps/recommendation

表4-46 路径参数

API 参考 4 API

(37)

请求参数

text 否 String 输入语句，根据语句中的实体信

息推荐相应知识。说明：请求参数中，“sources” 和

“ text”必须有一个为非空。如果同时为非空，则忽略“text”

的值，以“sources”为推荐算法输入。

size 否 Integer 希望返回的节点总个数，

1~100，默认为10。

最小值：1 最大值：100

steps 否 Integer 推荐算法总的游走步数，

1~200000，默认为1000。

最小值：1 最大值：200000 缺省值：1000

label 否 String 希望输出的概念类型。

sources 否 String 实体id，可以是多个。但不能超过10个。多个用“,”间隔。

响应参数

状态码： 200

total Integer 推荐结果个数。

entities KgRecomme ndRespEntiti es object

推荐结果详情。

API 参考 4 API

(38)

表4-49 KgRecommendRespEntities

id String 推荐的实体节点ID。

name String 推荐的实体节点名称。

score Double 推荐得分，供参考，分值越高说明推荐程度越高。

状态码： 400

状态码： 403

状态码： 500

请求示例

6cdcea01-bac0-48f6-acb5-9385ea3e24ad/apps/recommand { "text" : "不止英雄的主演卜发",

"size" : 1, "steps" : 200000,

API 参考 4 API

(39)

"label" : "电影"

}

响应示例

状态码： 200 OK

{ "total" : 1, "entities" : [ {

"id" : "9171851267583370758", "name" : "忆青春",

"score" : 42514.35090209614 } ]

}

{ "error_code" : "KGP.2001", "error_msg" : "Kg not found"

}

状态码

错误码

API 参考 4 API

(40)

5 ^数据结构

5.1 公共响应参数

表5-1 公共响应消息头

名称描述

Content-Length 响应消息体的字节长度，单位为Byte。

Date 系统响应的时间。

Content-type 发送的实体的MIME类型。

5.2 公共请求参数

表5-2 公共请求消息头

名称描述是否必选示例

Content-type 发送的实体的

MIME类型。是 application/json Content-Length 请求body长度，单

位为Byte。 POST/PUT请求为

可选， GET不包含 3495

X-Auth-Token 用户Token。是 MIINRwYJKoZIhvc NAQcCoIINODCC DTQCAQExDTALB glghkgBZQMEAgE wgguVBgkqhkiG...

X-Language 请求语言类型。否，默认为zh-cn en-us

API 参考 5 数据结构

(41)

说明

其它header属性，请遵照https协议。

API 参考 5 数据结构

(42)

6 ^附录

6.1 状态码

● 正常状态码

返回值说明

200 OK 请求成功。

201 Created 请求成功，资源已创建。

204 No Content 请求成功，返回体无内容。

● 异常状态码

返回值说明

400 Bad Request 请求错误。

401 Unauthorized 鉴权失败。

403 Forbidden 没有操作权限。

500 Internal Server Error 服务内部错误。

503 Service Unavailable 服务不可用。

6.2 错误码

当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。

状态码错误码错误信息描述处理措施

400 KGP.0001 请求体格式非法。

请求体格式非法。

检查请求体格式。

API 参考 6 附录

(43)

状态码错误码错误信息描述处理措施 400 KGP.0002 请求参数错

误。

请求参数错误。

检查请求体参数。

400 KGP.0003 资源重名。资源重名。修改资源名称。

400 KGP.1001 未找到本体。未找到本体。检查本体ID。

400 KGP.1002 本体被占用。本体被占用。释放本体。

400 KGP.1003 导入本体格式错误。

导入本体格式错误。

检查导入文件格式。

400 KGP.2001 未找到图谱。未找到图谱。检查图谱ID。

400 KGP.2002 无法删除图谱。

无法删除图谱。

图谱任务执行中无法删除。

400 KGP.2003 图谱查询语句执行失败。

图谱查询语句执行失败。

检查图谱查询语句格式。

400 KGP.2004 图谱超出配额。

图谱超出配额。

检查配额。

400 KGP.2007 未找到实体。未找到实体。检查实体查询条件。

400 KGP.2008 图谱未就绪。图谱未就绪。等待图谱就绪。

400 KGP.3001 OBS资源未找

到。 OBS资源未找

到。检查OBS桶名、路

径。

400 KGP.4001 Gremlin查询

失败。 Gremlin查询

失败。检查Gremlin查询语句语法逻辑。

400 KGP.4002 实体未找到。实体未找到。检查请求中的实体 ID。

400 KGP.4004 过滤查询请求错误

过滤查询请求错误

检查过滤查询请求体。

400 KGP.4010 调用量超过每日限制。

调用量超过每日限制。

调用量已超过当前图谱版本每日限制。

400 KGP.4201 图谱应用未启动。

图谱应用未启动。

开启图谱应用开关。

400 KGP.4203 图谱的实体数或关系数不能为0。

图谱的实体数或关系数不能为0。

图谱应用开启时，

图谱实体或关系数量不能为0。

400 KGP.4204 图谱应用承载实体数量超过上限。

图谱应用承载实体数量超过上限。

图谱应用开启，图谱中实体或关系数量太多。

API 参考 6 附录

(44)

状态码错误码错误信息描述处理措施 400 KGP.5001 任务配置不完

全。

任务配置不完全。

检查任务配置。

400 KGP.5002 未找到任务。未找到任务。检查任务ID。

400 KGP.5004 任务已执行过。

任务已执行

过。检查任务ID。

400 KGP.5005 任务执行中。任务执行中。等待任务执行完成。

400 KGP.5007 任务类型错误。

任务类型错误。

修改任务类型

400 KGP.5008 任务状态错误。

任务状态错误。

检查任务状态。

403 KGP.0004 认证失败。认证失败。检查认证token。

403 KGP.0005 测试权限校验失败。

测试权限校验失败。

申请测试权限。

403 KGP.3002 无OBS资源访

问权限。无OBS资源访

问权限。检查OBS权限。

500 KGP.5003 内部服务错误。

内部服务错误。

联系技术支持人员。

6.3 获取项目 ID

从控制台获取项目 ID

在调用接口的时候，部分URI中需要填入项目编号，所以需要先在管理控制台上获取到项目编号。

项目编号获取步骤如下：

1. 注册并登录管理控制台。

2. 单击用户名，在下拉列表中选择“我的凭证”。

在“我的凭证”页面的项目列表中查看项目ID。

API 参考 6 附录

(45)

图6-1 查看项目 ID

多项目时，展开“所属区域”，从“项目ID”列获取子项目ID。

调用 API 获取项目 ID

项目ID还用通过调用查询指定条件下的项目信息API获取。

获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM 的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。

响应示例如下，知识图谱服务部署的区域为"cn-north-4"，响应消息体中查找

“name”为"cn-north-4"，其中projects下的“id”即为项目ID。

{ "projects": [ {

"domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false,

"parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4",

"description": "", "links": { "next": null, "previous": null,

"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"

},

"id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true

} ], "links": { "next": null, "previous": null,

"self": "https://www.example.com/v3/projects"

} }

6.4 获取帐号 ID

在调用接口的时候，部分URL中需要填入帐号ID（domain-id），所以需要先在管理控制台上获取到帐号ID。帐号ID获取步骤如下：

1. 注册并登录管理控制台。

2. 单击用户名，在下拉列表中单击“我的凭证”。

在“我的凭证”页面的项目列表中查看帐号ID。

API 参考 6 附录

(46)

图6-2 获取帐号 ID

API 参考 6 附录

(47)

7 ^修订记录

发布日期修改说明

2019-09-13 第一次正式发布。

API 参考 7 修订记录

查询关联实体_知识图谱 KG_API参考_API_华为云

知识图谱

API 参考

目 录

1 使用前必读... 1

2 API 概览... 4

3 如何调用 API...5

4 API...11

5 数据结构...37

6 附录... 39

7 修订记录...44

1 使用前必读

1.1 概述

1.2 调用说明

1.3 终端节点

1.4 约束与限制

1.5 基本概念

2 API 概览

3 如何调用 API

3.1 构造请求

请求 URI

请求方法

请求消息头

请求消息体

username

domainname

********

xxxxxxxxxxxxxxxxxx

3.2 认证鉴权

Token 认证

usernam用户名

domainname

********

projectname

cn-north-4

cn-north-4

projectname

cn- north-4

AK/SK 认证

3.3 返回结果

状态码

响应消息头

响应消息体

4 API

4.1 执行知识图谱查询命令

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

4.2 查询实体详情

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

4.3 过滤查询实体列表

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

4.4 查询关联实体

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

目录

1 ^{使用前必读}

2 ^{API 概览}

3 ^{如何调用 API}

4 ^API

5 ^数据结构

6 ^附录

7 ^修订记录