实体标注
更新时间:2021-06-02
简介
Hi,您好,欢迎使用百度知识图谱知识理解的API服务。
本文档主要针对API开发者,描述百度知识图谱的相关技术内容。如果您对文档内容有任何疑问,可以通过以下方式联系我们:
1.在百度云控制台内提交工单,咨询问题类型请选择人工智能-知识图谱;
2.百度AI社区--知识图谱官方版块:http://ai.baidu.com/forum/topic/list/174
实体标注接口
接口描述
实体标注接口:支持输入一段中文短文本(64个汉字以内),识别短文本中的实体,并给出实体的分类、描述、百科实体链接等。
(备注:如需申请使用和提高调用额度,请通过实体标注介绍页面的“合作咨询”提交申请。)
请求说明
- HTTP方法:
POST
- 请求URL:
https://aip.baidubce.com/rpc/2.0/kg/v1/cognitive/entity_annotation
- URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
- Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
-
body请求示例:
{ "data": "刘德华的老婆" }
请求格式
POST方式调用
注意:要求使用JSON格式的结构体来描述一个请求的具体内容。
body整体文本内容可以支持GBK和UTF-8两种格式的编码。
1、GBK支持:默认按GBK进行编码,输入内容为GBK编码,输出内容为GBK编码,否则会接口报错编码错误
2、UTF-8支持:若文本需要使用UTF-8编码,请在url参数中添加charset=UTF-8 (大小写敏感)
例如 https://aip.baidubce.com/rpc/2.0/nlp/v1/lexer?charset=UTF-8&access_token=24.f9ba9c5241b67688bb4adbed8bc91dec.2592000.1485570332.282335-8574074
请求参数
参数 | 类型 | 描述 |
---|---|---|
data | string | 需要进行实体标注的文本字符串(最多64个汉字,utf8编码) |
返回格式
JSON格式
默认返回内容为GBK编码
若用户指定输入为UTF-8编码(通过指定charset参数),则返回内容为UTF-8编码
返回参数
参数 | 类型 | 描述 |
---|---|---|
log_id | int | 请求logid |
entity_annotation | array | 实体标注结果的数组集合 |
_bdbkKgId | string | 百科newid |
_bdbkUrl | string | 百科url |
annoType | string | 标注类型:Instance | Category | Property |
concept | array | 概念标注结果 |
+level1 | string | 一级概念 |
+level2 | string | 二级概念 |
confidence | string | 实体关联至该@id的置信度 |
desc | string | 实体的简介 |
mainReqRankList | array | 主需求实体,列出所有候选实体信息,根据热度从高到低排列 |
importance | string | 关联的实体在输入中的核心程度,越重要打分越高,打分区间为[0, 1] |
mention | string | 实体在query中的名字 |
offset | string | 实体在query中的位置偏移 |
status | string | 用于对关联结果进行标识,包括LINKED(正常关联)| LINKED_MAINREQ(主需求关联) | NIL(NIL实体,即不在库中)| UNK (未知)四种种状态。 只有当status值为LINKED, LINKED_MAINREQ时,才为有效的关联结果,NIL及UNK可以认为是mention识别的结果但无法和库中已有id进行关联, 在entity_annotation层次下 |
返回示例
{
"log_id": 6367018173853945311,
"entity_annotation": [
{
"status": "LINKED",
"confidence": "0.991616",
"concept": {
"level1": "人物",
"level2": "文化人物,娱乐人物"
},
"_bdbkKgId": "114923",
"mention": "刘德华",
"_bdbkUrl": "http://baike.baidu.com/item/%E5%88%98%E5%BE%B7%E5%8D%8E/114923",
"offset": "0",
"desc": "中国香港男演员、歌手、词作人"
},
{
"status": "LINKED",
"confidence": "0.817889",
"concept": {
"level1": "语言文化",
"level2": "文字词汇"
},
"_bdbkKgId": "827",
"mention": "老婆",
"_bdbkUrl": "http://baike.baidu.com/item/%E8%80%81%E5%A9%86/827",
"offset": "4",
"desc": "汉语词语"
}
]
}
错误码
错误信息返回示例
{
“error_code”:123455,
“error_msg”:”error description”
“log_id”: 12345567898
}
错误码
错误码 | 英文描述 | 说明 |
---|---|---|
100 | Invalid parameter | 包含了无效或错误参数,请检查代码 |
110 | Access token invalid or no longer valid | Access Token失效 |
111 | Access token expired | Access token过期 |
282000 | internal error | 内部错误 |
282356 | input length exceeds limit | 输入长度超限 |