更新时间:2021-10-15 GMT+08:00
分享

知识搜索

功能介绍

对用户文本进行分析,对图谱中的相关知识进行搜索。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

kg_id

String

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

project_id

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

query

String

用户搜索的语句。

最小长度:1

最大长度:512

limit

Integer

限制返回的数量,默认为10。

最小值:1

最大值:100

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

搜索结果个数。

entites

KgSearchRespEntities object

搜索结果详情。

表4 KgSearchRespEntities

参数

参数类型

描述

id

String

实体ID。

label

String

实体类型。

name

String

实体的名称。

properties

Map<String,String>

实体的属性及属性值。

score

Integer

关联度得分,作为参考,分值越高关联程度越大。

状态码: 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

错误信息

请求示例

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

{
  "query" : "不止英雄的票房",
  "limit" : 100
}

响应示例

状态码: 200

OK

{
  "total" : 2,
  "entities" : [ {
    "name" : "不止英雄",
    "score" : 1,
    "id" : "6751625866271911141",
    "label" : "电影",
    "properties" : {
      "票房" : "19.50亿"
    }
  }, {
    "name" : "乱世出英雄",
    "score" : 0.137613,
    "id" : "4861731593422907967",
    "label" : "电影",
    "properties" : {
      "上映时间" : "1965年1月4日",
      "票房" : "5.40亿"
    }
  } ]
}

状态码: 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

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读