检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 KG服务提供接口请参见表1,您可以使用知识图谱数据面管理功能。 表1 知识图谱数据面接口 API 说明 执行知识图谱查询命令 根据图谱ID执行知识图谱查询命令。 查询实体详情 根据图谱ID和实体ID查询实体详情,包括实体的ID、类型、属性及属性值。 过滤查询实体列表
API 执行知识图谱查询命令 查询实体详情 过滤查询实体列表 查询关联实体 进行KBQA会话 实体链接 知识搜索 知识推荐
如何调用API 构造请求 认证鉴权 返回结果
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过视频教程了解如何构造请求调用API 。 请求URI 请求URI由如下部分组成。 {URI-scheme}
相连。 edge AdjacentEdgeDetail object 关系详情。 direction String 关系方向,枚举值,有OUT和IN两种,OUT表示出,IN表示指入。 枚举值: IN OUT 表6 AdjacentEdgeDetail 参数 参数类型 描述 relation_label
对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体
由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序
关系ID,格式为“source(头实体ID)-target(尾实体ID)-index(关系索引值)”,如“4730302-1963128-1”,表示ID为4730302的实体和ID为1963128的实体之间的第1个关系。 index String 关系的索引值,标识该条关系是其头尾实体的第几个关系。 label String
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点。 知识图谱服务的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 知识图谱的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京四
项目ID。 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop
关系ID,格式为“source(头实体ID)-target(尾实体ID)-index(关系索引值)”,如“4730302-1963128-1”,表示ID为4730302的实体和ID为1963128的实体之间的第1个关系。 index String 关系的索引值,标识该条关系是其头尾实体的第几个关系。 label String
约束与限制 您能创建的知识图谱服务器的数量与配额有关系,具体请参见服务配额。 更详细的限制请参见具体API的说明。 父主题: 使用前必读
"票房" : [ "34.72亿" ] } } ] } 状态码 状态码 描述 200 OK 错误码 请参见错误码。 父主题: API
查询实体详情 功能介绍 根据图谱ID和实体ID查询实体详情,包括实体的ID、类型、属性及属性值。 URI GET /v1/{project_id}/kg/kg-instances/{kg_id}/entities/{entity_id} 表1 路径参数 参数 是否必选 参数类型 描述
是否必选 参数类型 描述 text 否 String 输入语句,根据语句中的实体信息推荐相应知识。 说明: 请求参数中,“sources” 和“ text”必须有一个为非空。如果同时为非空,则忽略“text”的值,以“sources”为推荐算法输入。 最小长度:0 最大长度:512
failed" } 状态码 状态码 描述 200 OK 400 Bad Request 403 Forbidden 错误码 请参见错误码。 父主题: API
Bad Request 403 Forbidden 500 Internal Server Error 错误码 请参见错误码。 父主题: API
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 注册并登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“我的凭证”页面的项目列表中查看账号ID。 图1 获取账号ID
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KGP.0001 请求体格式非法。 请求体格式非法。 检查请求体格式。 400 KGP.0002 请求参数错误。 请求参数错误。 检查请求体参数。