/
overview.html
47 lines (40 loc) · 2.69 KB
/
overview.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<!DOCTYPE html>
<html>
<head>
<title>ARAX UI Overview</title>
<link rel="stylesheet" type="text/css" href="rtx.css">
</head>
<body>
<div class="banner" banner-bg-text="ARAX UI Overview">
<span class="menulinks">Documentation:
<span class="currentpage">Overview</span>
<a href="api/arax/v1.3/ui/">TRAPI 1.3.0</a>
<a href="https://github.com/RTXteam/RTX/wiki/RTX-Home">Resources</a>
</span>
</div>
<div style="margin-left: 50px; margin-right: 50px; max-width: 800px;">
<br>
<br>
<h1>Summary</h1>
<p>The <b>ARAX Expander team</b> has developed the Autonomous Relay Agent (ARA) called ARAX as part of the NCATS Translator project. The current user interface (UI) consists of two parts:<br>
<ol>
<li> A full <b>web services interface</b> supporting version 1.3.0 of the <a target="_blank" href="https://github.com/NCATSTranslator/ReasonerAPI">Translator Reasoner API (TRAPI)</a></li>
<li> A light Javascript-based <b>GUI</b> to make testing and visualization of results easier. The GUI is simply a thin client for the TRAPI 1.3.0 back end.</li>
</ol>
All functionality is easily available from any remote tool that uses the API.</p>
<h1>Web Services Interface</h1>
<p>The web services interface expects and returns a JSON object as defined by the OpenAPI based TRAPI definition. Both the API framework code, Python classes, and the <a target="_blank" href="api/arax/v1.3/ui/">documentation for this interface</a>
are autogenerated using OpenAPI tools and can be tested interactively.</p>
<h1>Interactive Interface</h1>
<p>The <a target="_blank" href="index.html">interactive interface is a simple Javascript-enhanced web page</a> with input boxes to define queries and a results section. A few example questions are provided on the page to simplify testing.</p>
<p>There are four different ways to present queries to ARAX:<br>
<ol>
<li> The original RTX <b>canned-question</b> mechanism whereby an English language question is parsed and matched to one of the template questions and then answered if possible</li>
<li> A <b>query graph-based</b> mechanism by which an interactive tool helps the user build a query graph, which is sent to the server for answering</li>
<li> A JSON <b>query_graph</b> snippet can be pasted into a text window. The actual "query_graph": tag should NOT be included in the paste, but rather just: { "nodes": {...}, "edges": {...} }</li>
<li> A powerful domain specific language (DSL) mechanism called <b>ARAXi</b> that allows power users direct access to all the ARAX modular components individually or in series to create new or operate on existing TRAPI Messages</li>
</ol>
All Responses are stored on the server and can be easily recalled via their id URI.</p>
</div>
</body>
</html>