检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 执行知识图谱查询命令 查询实体详情 过滤查询实体列表 查询关联实体 进行KBQA会话 实体链接 知识搜索 知识推荐
API概览 KG服务提供接口请参见表1,您可以使用知识图谱数据面管理功能。 表1 知识图谱数据面接口 API 说明 执行知识图谱查询命令 根据图谱ID执行知识图谱查询命令。 查询实体详情 根据图谱ID和实体ID查询实体详情,包括实体的ID、类型、属性及属性值。 过滤查询实体列表
如何调用API 构造请求 认证鉴权 返回结果
查询关联实体 功能介绍 指定知识图谱实例ID,在ID对应的知识图谱后端,查询与指定实体有一跳关系的实体,返回满足条件的实体列表。 URI GET /v1/{project_id}/kg/kg-instances/{kg_id}/entities/{entity_id}/adjacent-entities
查询实体详情 功能介绍 根据图谱ID和实体ID查询实体详情,包括实体的ID、类型、属性及属性值。 URI GET /v1/{project_id}/kg/kg-instances/{kg_id}/entities/{entity_id} 表1 路径参数 参数 是否必选 参数类型 描述
过滤查询实体列表 功能介绍 根据图谱ID,过滤查看满足指定条件的实体列表,列表信息包括实体ID、实体类型、实体属性及其属性值。 URI POST /v1/{project_id}/kg/kg-instances/{kg_id}/entities/property-query 表1
String 需要执行的gremlin查询语句,只能执行与查询功能相关的语句,不能执行修改图谱相关功能的语句。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data GremlinQueryRespData object 查询结果。请求失败时,字段为空。 表4
resource-path:资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,
Double 匹配模板对应的匹配得分。 query String 系统查询答案时使用的查询语句。 result GremlinQueryRespData object 查询语句对应的查询结果。 answer String 查询语句对应的答案文本。 表5 GremlinQueryRespData
failed" } 状态码 状态码 描述 200 OK 400 Bad Request 403 Forbidden 错误码 请参见错误码。 父主题: API
Bad Request 403 Forbidden 500 Internal Server Error 错误码 请参见错误码。 父主题: API
Bad Request 403 Forbidden 500 Internal Server Error 错误码 请参见错误码。 父主题: API
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-tok
KGP.4001 Gremlin查询失败。 Gremlin查询失败。 检查Gremlin查询语句语法逻辑。 400 KGP.4002 实体未找到。 实体未找到。 检查请求中的实体ID。 400 KGP.4004 过滤查询请求错误 过滤查询请求错误 检查过滤查询请求体。 400 KGP.4010
票房是10亿的电影 xx实体 的 xx关系(正向一跳关系) 月光宝盒的导演 xx实体 的 xx关系(正向一跳关系)+ 概念限制 月光宝盒的导演是哪个人物 xx实体 和 xx实体 的关系 月光宝盒和沈振的关系 xx实体 的 xx关系 的 xx属性(正向一跳关系的属性) 月光宝盒的导演的出生日期
项目ID。 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 注册并登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“我的凭证”页面的项目列表中查看账号ID。 图1 获取账号ID
管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内
附录 状态码 错误码 获取项目ID 获取账号ID 系统内置模板