简介
atb-insight-api
是一个基于ATB数据的JavaScript客户端库,用于通过API访问ATB数据。该库提供了可靠、高效、易用的方式去访问和分析ATB数据,并以JSON格式返回结果。atb-insight-api
可以在浏览器中用JavaScript脚本或在 Node.js 中使用。
需求
使用 atb-insight-api
,你需要具备以下技能:
- JavaScript编程知识;
- 运行Node.js或使用浏览器环境;
- 了解ATB数据的概念。
安装
通过npm安装atb-insight-api
:
npm install atb-insight-api
API
ATBInsight
需要首先使用 Code
获得 access_key
,这是 atb-insight-api
访问 ATB 数据的身份凭证(specific info and address may vary in different regions)。拿到 access_key
后需要以如下代码形式实例化 ATBInsight
:
var ATBInsight = require('atb-insight-api'); var atbInsight = new ATBInsight({ accessKey: '<your access key>', endpoint: '<atb endpoint, optional>', timeout: 15000 });
其中,endpoint
选项是ATB的请求地址,如果缺省,ATBInsight会自动选择处理请求的 region。timeout 选项是调用 API 的超时时间,默认是 15000(单位毫秒)。
atbInsight.getLanguageVersion(language, version, query)
获取特定语言、 特定版本的医学知识图谱数据。language
选项是指定语言的名称,指定的语言必须是ATB支持的,如 'en'(英语),'de'(德语),默认 'en';version
选项是指定语言的版本号,如 '2022_2',默认是最新版本;query
选项是指定查询字符串,返回 ATB 中匹配的节点和边,用于搜索特定节点,其中一些参数必传,如下:
-- -------------------- ---- ------- ----------------------------------- --------- - ------ -------- ------- -- ----- ---------- --------------- -- ------ -------- ------------------- -- ------ ------ ---------------- -- ------ ------- ----------------- -- ----- ----------- -- - ----------------- ---
返回是包括匹配的节点和连接的JSON格式数据。
atbInsight.getSimilarityScores(language, node1, node2)
获取两个节点间的相似性分数。language
选项是指定语言的名称,指定的语言必须是ATB支持的,如 'en'(英语),'de'(德语),默认 'en';node1
和 node2
选项是指定两个节点来比较他们的相似性。示例代码:
atbInsight.getSimilarityScores('en', '<node_1>', '<node_2>').then(res => { console.log(res); })
返回值是JSON格式数据,其中包含指定节点间的相似性分数。
示例代码
下面是一个完整 Node.js 示例代码,将获得两个节点之间的相似性分数。在运行此代码之前,请确保你的机器能够正常访问ATB数据平台。
使用 ATBInsight 这个包进行两个节点的比较:
-- -------------------- ---- ------- ----- ---------- - --------------------------- -- --- ---------- ----- ---------- - --- ------------ ---------- ------ ------ ----- --- -- ------------ ------------------------------------ -------- ----------------- -- - ----------------- ------------ -- - ------------------- ---
如果获得了预期的结果,那么输出应该是如下格式的Json:
-- -------------------- ---- ------- - -------- -------- -------- -------- -------------------- - - -------- ------------- ------- ------- -- - -------- -------------- ------- ------- - - -
总结
atb-insight-api
可以帮助你通过API访问ATB数据,并对数据进行一定的分析和使用。通过本文,你了解了 atb-insight-api
的使用方法,并获得了一些实例代码来帮助你更好地使用这个API。如果你有任何API使用方面的问题,欢迎在评论区留言,我将尽力解答。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600566b281e8991b448e2f51