检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
查询关联实体 功能介绍 指定知识图谱实例ID,在ID对应的知识图谱后端,查询与指定实体有一跳关系的实体,返回满足条件的实体列表。 URI GET /v1/{project_id}/kg/kg-instances/{kg_id}/entities/{entity_id}/adjacent-entities
如何调用API 构造请求 认证鉴权 返回结果
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过视频教程了解如何构造请求调用API 。 请求URI 请求URI由如下部分组成。 {URI-scheme}
过滤查询实体列表 功能介绍 根据图谱ID,过滤查看满足指定条件的实体列表,列表信息包括实体ID、实体类型、实体属性及其属性值。 URI POST /v1/{project_id}/kg/kg-instances/{kg_id}/entities/property-query 表1
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需
附录 状态码 错误码 获取项目ID 获取账号ID 系统内置模板
执行知识图谱查询命令 功能介绍 指定知识图谱实例ID,在ID对应的知识图谱后端执行gremlin查询命令。gremlin命令仅限于读取操作,禁止执行修改操作。 URI POST /v1/{project_id}/kg/kg-instances/{kg_id}/gremlin-query
数据结构 公共响应参数 公共请求参数
状态码 正常状态码 返回值 说明 200 OK 请求成功。 201 Created 请求成功,资源已创建。 204 No Content 请求成功,返回体无内容。 异常状态码 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 鉴权失败。 403
修订记录 发布日期 修改说明 2024-04-14 修改“帐”为“账”。 2019-09-13 第一次正式发布。
系统内置模板 当用户问题对应的匹配模板的类型为系统内置模板(SYS_TEMPLATE)时,可参考系统内置模板列表。 表1 系统内置模板列表 模板 举例说明 实体名称 月光宝盒 xx实体 + 呢 月光宝盒呢 xx实体 的 xx属性 月光宝盒的上映时间 xx实体属性 + 呢 上映时间呢
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KGP.0001 请求体格式非法。 请求体格式非法。 检查请求体格式。 400 KGP.0002 请求参数错误。 请求参数错误。 检查请求体参数。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 注册并登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“我的凭证”页面的项目列表中查看账号ID。 图1 获取账号ID
调用说明 知识图谱服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
获取项目ID 从控制台获取项目ID 在调用接口的时候,部分URI中需要填入项目编号,所以需要先在管理控制台上获取到项目编号。 项目编号获取步骤如下: 注册并登录管理控制台。 单击用户名,在下拉列表中选择“我的凭证”。 在“我的凭证”页面的项目列表中查看项目ID。 图1 查看项目ID
概述 欢迎使用知识图谱服务 (Knowledge Graph,简称KG) 。知识图谱是面向各类企业的一站式知识计算平台,提供本体管理、图谱管理、图谱构建等功能,帮助用户从0到1快速构建知识图谱,管理知识图谱流水线任务。 在调用知识图谱服务API之前,请确保已经充分了解知识图谱服务相关概念,详细信息请参见产品介绍。
约束与限制 您能创建的知识图谱服务器的数量与配额有关系,具体请参见服务配额。 更详细的限制请参见具体API的说明。 父主题: 使用前必读
公共响应参数 表1 公共响应消息头 名称 描述 Content-Length 响应消息体的字节长度,单位为Byte。 Date 系统响应的时间。 Content-type 发送的实体的MIME类型。 父主题: 数据结构