检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 执行知识图谱查询命令 查询实体详情 过滤查询实体列表 查询关联实体 进行KBQA会话 实体链接 知识搜索 知识推荐
API概览 KG服务提供接口请参见表1,您可以使用知识图谱数据面管理功能。 表1 知识图谱数据面接口 API 说明 执行知识图谱查询命令 根据图谱ID执行知识图谱查询命令。 查询实体详情 根据图谱ID和实体ID查询实体详情,包括实体的ID、类型、属性及属性值。 过滤查询实体列表
如何调用API 构造请求 认证鉴权 返回结果
约束与限制 您能创建的知识图谱服务器的数量与配额有关系,具体请参见服务配额。 更详细的限制请参见具体API的说明。 父主题: 使用前必读
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过视频教程了解如何构造请求调用API 。 请求URI 请求URI由如下部分组成。 {URI-scheme}
查询关联实体 功能介绍 指定知识图谱实例ID,在ID对应的知识图谱后端,查询与指定实体有一跳关系的实体,返回满足条件的实体列表。 URI GET /v1/{project_id}/kg/kg-instances/{kg_id}/entities/{entity_id}/adjacent-entities
使用API调用知识图谱服务 本章节提供了通过Postman调用知识图谱服务API的样例,帮助您快速熟悉零编码使用KG服务的方法。 调用KG服务API的详细步骤如下所示: 步骤1:配置环境 步骤2:Token认证鉴权 步骤3:调用服务 准备工作 已注册华为账号,并完成实名认证。具体
String 链接到的图谱节点对应的实体id。 entity_title String 链接到的图谱节点对应的实体名称。 mention String 实体名称。 offset Integer 实体文本在待分析文本中的起始位置。 请求示例 分析识别文本为 "李娜唱的青藏高原真好听"的实体 https://nlp-ext
对用户文本进行分析,对图谱中的相关知识进行搜索。 URI POST /v1/{project_id}/kg/kg-instances/{kg_id}/apps/query 表1 路径参数 参数 是否必选 参数类型 描述 kg_id 是 String 知识图谱ID。在KG服务控制台“我的图谱”页面,
ken接口时,请求body中auth.scope的取值需要选择project,如下所示。 获取用户Token接口请求构造如下,您可以从接口的请求部分看到所需的请求参数及参数说明。获取Token消息头只需填写“Content-Type”。将消息体加入后的请求如下所示,加粗的斜体字段
template_id String 用户问题对应的匹配模板的ID。 template_name String 用户问题对应的匹配模板的名称。 template_score Double 匹配模板对应的匹配得分。 query String 系统查询答案时使用的查询语句。 result GremlinQueryRespData
text”必须有一个为非空。如果同时为非空,则忽略“text”的值,以“sources”为推荐算法输入。 最小长度:0 最大长度:512 size 否 Integer 希望返回的节点总个数,1~100,默认为10。 最小值:1 最大值:100 steps 否 Integer 推荐算法总的游走步数,1~200000,默认为1000。
查询实体详情 功能介绍 根据图谱ID和实体ID查询实体详情,包括实体的ID、类型、属性及属性值。 URI GET /v1/{project_id}/kg/kg-instances/{kg_id}/entities/{entity_id} 表1 路径参数 参数 是否必选 参数类型 描述
表4 响应Body参数 参数 参数类型 描述 count Integer 当前返回的实体结果个数。 results Array of EntityDetailResp objects 符合过滤条件的实体列表。 表5 EntityDetailResp 参数 参数类型 描述 id String
0302-1963128-1”,表示ID为4730302的实体和ID为1963128的实体之间的第1个关系。 index String 关系的索引值,标识该条关系是其头尾实体的第几个关系。 label String 关系的类型。 source String 关系头实体ID。 target
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KGP.0001 请求体格式非法。 请求体格式非法。 检查请求体格式。 400 KGP.0002 请求参数错误。 请求参数错误。 检查请求体参数。
以根据本文档提供的API使用服务,支持的全部API请参见API概览。 父主题: 使用前必读
项目ID。 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
附录 状态码 错误码 获取项目ID 获取账号ID 系统内置模板