API接口使用
说明
- 每次使用接口服务都需要附带一个密钥,用于认证信息。
- 每个账号有一个单独的签名秘钥,更改密码或账号信息会变更秘钥,请妥善保管。
您的密钥是
协议须知
调用API时,请遵循以下规则。
| 规则 |
描述 |
| 传输方式 |
HTTPS |
| 请求方式 |
GET/POST |
| 字符编码 |
统一使用UTF-8-编码 |
| 请求格式 |
表单 |
| 响应格式 |
JSON |
接口使用示例
https://cpubmed.openi.org.cn/graph/schema?entity=库欣病&sign=
获取实体相关三元组API
应用地址:
https://cpubmed.openi.org.cn/graph/schema
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 |
类型 |
含义 |
必填 |
备注 |
| entity |
text |
实体名称 |
True |
支持模糊匹配最接近实体 |
| sign |
text |
密钥 |
True |
每个账号一个独有的密钥 |
返回结果
| 字段名 |
类型 |
含义 |
备注 |
| entity_schema |
dict |
与查询实体相关联的三元组 |
{实体名称:[关系1:{[尾实体,三元组ID],...},关系2...]} |
示例(输入:entity=糖尿病)
{ "糖尿病": {
"辅助检查": [[ "生化检验", "2420" ],[ "眼底荧光造影检查", "84106" ],...],
"病因": [[ "饮食不规律", "44484" ],[ "胰岛功能减退", "81235" ],...],
"药物治疗": [[ "依帕司他", "696" ], [ "甲钴胺", "697" ],...],
"并发症": [ [ "尿毒症", "1086" ], [ "冠心病", "1352" ],...],
...
}}
获取三元组信息API
应用地址:
https://cpubmed.openi.org.cn/graph/triple-info
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 |
类型 |
含义 |
必填 |
备注 |
| ID |
text |
三元组ID |
True |
一般为几个数字 |
| sign |
text |
密钥 |
True |
每个账号一个独有的密钥 |
返回结果
| 字段名 |
类型 |
含义 |
备注 |
| triple |
Array |
三元组内容 |
[三元组id,头实体,关系,尾实体] |
| text |
text |
来源文本 |
三元组抽取的来源文本 |
| doc_num |
integer |
文献数量 |
得到这个知识的文献数量 |
| doc_title |
Array |
来源文献标题 |
所有来源文献的标题 |
示例(输入:ID=14529)
{
"triple_id": "14529",
"doc_id": "46790947,22917575,...",
"text": "糖尿病大鼠血管平滑肌细胞内质网应激因子GRP78和caspase12的表达及阿托伐他汀的干预作用",
"doc_num": 198,
"doctitle": ["糖尿病大鼠血管平滑肌细...", "阿托伐他汀对2型糖尿病鼠...", ...]
}
获取实体具体关系详细信息API
应用地址:
http://cpubmed.openi.org.cn/graph/triple-sp
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 |
类型 |
含义 |
必填 |
备注 |
| header |
text |
头实体名称 |
True |
支持模糊匹配最接近实体 |
| relation |
text |
关系类型 |
True |
实体间的特定关系 |
| sign |
text |
密钥 |
True |
每个账号一个独有的密钥 |
返回结果
| 字段名 |
类型 |
含义 |
备注 |
| header |
text |
头实体名称 |
查询的实体名称 |
| relation |
text |
关系类型 |
查询的关系类型 |
| triples |
Array |
三元组详细信息 |
包含尾实体和来源信息的数组 |
| end_entity |
text |
尾实体名称 |
三元组中的尾实体 |
| triple_id |
text |
三元组ID |
唯一标识符 |
| source |
Object |
来源信息 |
包含文献详细信息的对象 |
返回示例
{
"header": "库欣病",
"relation": "病理分型",
"triples": [
{
"end_entity": "微腺瘤",
"triple_id": "3602323",
"source": {
"doc_id": "2735201",
"text": "方法回顾性分析本院1985年~1996年76例库欣病患者...",
"doc_title": ["库欣病病理分型研究"]
}
},
{
"end_entity": "大腺瘤",
"triple_id": "3602324",
"source": {
"doc_id": "2735201",
"text": "方法回顾性分析本院1985年~1996年76例库欣病患者...",
"doc_title": ["库欣病病理分型研究"]
}
}
]
}
医学分词API
应用地址:
https://cpubmed.openi.org.cn/graph/cut
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 |
类型 |
含义 |
必填 |
备注 |
| query |
text |
待分词的句子 |
True |
中文 |
| sign |
text |
密钥 |
True |
每个账号一个独有的密钥 |
返回结果
| 字段名 |
类型 |
含义 |
备注 |
| cut_result |
array |
分词结果 |
[[词,词类别],[词,词类别],...] |
三元组匹配API
应用地址:
https://cpubmed.openi.org.cn/graph/match
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 |
类型 |
含义 |
必填 |
备注 |
| query |
text |
输入句子 |
True |
用于匹配三元组的文本 |
| sign |
text |
密钥 |
True |
每个账号一个独有的密钥 |
返回结果
| 字段名 |
类型 |
含义 |
备注 |
| match_result |
array |
匹配结果 |
[[三元组id,头实体,关系,尾实体],[三元组id,头实体,关系,尾实体],...] |
医学文献检索API
应用地址:
https://cpubmed.openi.org.cn/graph/retrieve
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 |
类型 |
含义 |
必填 |
备注 |
| query |
text |
查询文本 |
True |
用于文献检索的句子 |
| sign |
text |
密钥 |
True |
每个账号一个独有的密钥 |
返回结果
| 字段名 |
类型 |
含义 |
备注 |
| docid |
text |
文献编号 |
文献的唯一标识符 |
| title |
text |
文献标题 |
|
| keywords |
array |
关键词 |
[关键词1,关键词2,...] |
| abstract |
text |
摘要 |
文献摘要 |
查找实体间三元组路径API
应用地址:
https://cpubmed.openi.org.cn/graph/path
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 |
类型 |
含义 |
必填 |
备注 |
| source-entity |
text |
源实体 |
True |
查找路径的开始实体 |
| target-entity |
text |
目标实体 |
True |
查找路径的结束实体 |
| sign |
text |
密钥 |
True |
每个账号一个独有的密钥 |
返回结果
| 字段名 |
类型 |
含义 |
备注 |
| path-result |
array |
路径队列 |
[路径1,路径2,路径3,...] |
实体相似度计算API
应用地址:
https://cpubmed.openi.org.cn/graph/similarity
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 |
类型 |
含义 |
必填 |
备注 |
| ent1 |
text |
实体词 |
True |
用于计算相似度的实体词 |
| ent2 |
text |
实体词 |
True |
用于计算相似度的实体词 |
| sign |
text |
密钥 |
True |
每个账号一个独有的密钥 |
返回结果
| 字段名 |
类型 |
含义 |
备注 |
| score |
float |
相似度 |
分数越高,相似度越大 |
获取相近的实体词API
应用地址:
https://cpubmed.openi.org.cn/graph/similar-entity
接口调用参数
调用API需要向接口发送以下字段来访问服务。
| 字段名 |
类型 |
含义 |
必填 |
备注 |
| entity |
text |
实体词 |
True |
获取与该实体接近的实体词列表 |
| sign |
text |
密钥 |
True |
每个账号一个独有的密钥 |
返回结果
| 字段名 |
类型 |
含义 |
备注 |
| entities |
array |
实体列表 |
[实体1,实体2,...] |