检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
否,默认为zh-cn en-us 其它header属性,请遵照https协议。 父主题: 数据结构
URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint:指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取终端节点。
API 执行知识图谱查询命令 查询实体详情 过滤查询实体列表 查询关联实体 进行KBQA会话 实体链接 知识搜索 知识推荐
API概览 KG服务提供接口请参见表1,您可以使用知识图谱数据面管理功能。 表1 知识图谱数据面接口 API 说明 执行知识图谱查询命令 根据图谱ID执行知识图谱查询命令。 查询实体详情 根据图谱ID和实体ID查询实体详情,包括实体的ID、类型、属性及属性值。 过滤查询实体列表 根据图谱
如何调用API 构造请求 认证鉴权 返回结果
使用API调用知识图谱服务 本章节提供了通过Postman调用知识图谱服务API的样例,帮助您快速熟悉零编码使用KG服务的方法。 调用KG服务API的详细步骤如下所示: 步骤1:配置环境 步骤2:Token认证鉴权 步骤3:调用服务 准备工作 已注册华为账号,并完成实名认证。具体申请信息请见账号注册和实名认证
知识搜索 功能介绍 对用户文本进行分析,对图谱中的相关知识进行搜索。 URI POST /v1/{project_id}/kg/kg-instances/{kg_id}/apps/query 表1 路径参数 参数 是否必选 参数类型 描述 kg_id 是 String 知识图谱ID
实体链接 功能介绍 对用户文本进行分析,识别出其中的实体,并返回图谱中关联节点的信息。 URI POST /v1/{project_id}/kg/kg-instances/{kg_id}/apps/entity-linking 表1 路径参数 参数 是否必选 参数类型 描述 kg_id
知识推荐 功能介绍 根据输入的实体信息或文本,推荐相关的实体。 URI POST /v1/{project_id}/kg/kg-instances/{kg_id}/apps/recommendation 表1 路径参数 参数 是否必选 参数类型 描述 kg_id 是 String
查询关联实体 功能介绍 指定知识图谱实例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 路径参数 参数 是否必选 参数类型 描述
进行KBQA会话 功能介绍 知识图谱问答服务(Knowledge Base Question Answering,简称KBQA)利用机器对自然语言分析与处理能力,理解用户所提出的问题,并利用知识图谱中的结构化知识进行查询、推理,找到解决该问题的精准答案并反馈给用户,协助用户解决不同类型的问题
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需要使用一个
过滤查询实体列表 功能介绍 根据图谱ID,过滤查看满足指定条件的实体列表,列表信息包括实体ID、实体类型、实体属性及其属性值。 URI POST /v1/{project_id}/kg/kg-instances/{kg_id}/entities/property-query 表1
执行知识图谱查询命令 功能介绍 指定知识图谱实例ID,在ID对应的知识图谱后端执行gremlin查询命令。gremlin命令仅限于读取操作,禁止执行修改操作。 URI POST /v1/{project_id}/kg/kg-instances/{kg_id}/gremlin-query
附录 状态码 错误码 获取项目ID 获取账号ID 系统内置模板
修订记录 发布日期 修改说明 2024-04-14 修改“帐”为“账”。 2019-09-13 第一次正式发布。
数据结构 公共响应参数 公共请求参数
状态码 正常状态码 返回值 说明 200 OK 请求成功。 201 Created 请求成功,资源已创建。 204 No Content 请求成功,返回体无内容。 异常状态码 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 鉴权失败。 403