文档首页/ 知识图谱 KG/ API参考/ API/ 知识推荐
更新时间：2024-04-24 GMT+08:00
查看PDF
分享

知识推荐

功能介绍

根据输入的实体信息或文本，推荐相关的实体。

URI

POST /v1/{project_id}/kg/kg-instances/{kg_id}/apps/recommendation

表1 路径参数

参数

是否必选

参数类型

描述

kg_id

是

String

知识图谱ID。在KG服务控制台“我的图谱”页面，单击图谱名称，进入图谱详情页左上角获取知识图谱ID。

project_id

是

String

用户项目ID。获取方法请参见获取项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

text

否

String

输入语句，根据语句中的实体信息推荐相应知识。 说明： 请求参数中，“sources” 和“ text”必须有一个为非空。如果同时为非空，则忽略“text”的值，以“sources”为推荐算法输入。

最小长度：0

最大长度：512

size

否

Integer

希望返回的节点总个数，1~100，默认为10。

最小值：1

最大值：100

steps

否

Integer

推荐算法总的游走步数，1~200000，默认为1000。

最小值：1

最大值：200000

缺省值：1000

label

否

String

希望输出的概念类型。

最小长度：0

最大长度：512

sources

否

String

实体id，可以是多个。但不能超过10个。多个用“,”间隔。

最小长度：0

最大长度：750

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

推荐结果个数。

entities

KgRecommendRespEntities object

推荐结果详情。
表4 KgRecommendRespEntities

参数

参数类型

描述

id

String

推荐的实体节点ID。

name

String

推荐的实体节点名称。

score

Double

推荐得分，供参考，分值越高说明推荐程度越高。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

根据不止英雄的主演卜发推荐一部电影，推荐算法总的游走步数为200000

https://nlp-ext.cn-north-4.myhuaweicloud.com/v1/1604d8170cd84440a81281e5a3a04f8b/kg/kg-instances/6cdcea01-bac0-48f6-acb5-9385ea3e24ad/apps/recommand

{
  "text" : "不止英雄的主演卜发",
  "size" : 1,
  "steps" : 200000,
  "label" : "电影"
}

响应示例

状态码： 200

OK

{
  "total" : 1,
  "entities" : [ {
    "id" : "9171851267583370758",
    "name" : "忆青春",
    "score" : 42514.35090209614
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "KGP.2001",
  "error_msg" : "Kg not found"
}

状态码： 403

Forbidden

{
  "error_code" : "KGP.0004",
  "error_msg" : "Auth failed"
}

状态码： 500

Internal Server Error

{
  "error_code" : "KGP.9001",
  "error_msg" : "Internal server error."
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： API

相关文档