Spaces:
Sleeping
Sleeping
Update genesis/api_clients/umls_api.py
Browse files- genesis/api_clients/umls_api.py +58 -42
genesis/api_clients/umls_api.py
CHANGED
@@ -1,89 +1,105 @@
|
|
1 |
# genesis/api_clients/umls_api.py
|
2 |
import os
|
3 |
import requests
|
4 |
-
from typing import
|
5 |
|
6 |
-
UMLS_API_KEY = os.getenv("UMLS_API_KEY")
|
7 |
-
|
8 |
-
|
|
|
|
|
9 |
|
10 |
# -------------------------
|
11 |
# AUTHENTICATION
|
12 |
# -------------------------
|
13 |
def get_tgt() -> str:
|
14 |
"""
|
15 |
-
Get Ticket Granting Ticket (TGT) from UMLS
|
16 |
"""
|
17 |
-
|
18 |
-
|
19 |
-
|
20 |
-
|
21 |
-
|
22 |
-
|
|
|
23 |
|
24 |
-
def get_service_ticket(
|
25 |
"""
|
26 |
-
Get a
|
27 |
"""
|
28 |
-
|
29 |
-
r = requests.post(tgt_url, data=params)
|
30 |
r.raise_for_status()
|
31 |
return r.text
|
32 |
|
33 |
# -------------------------
|
34 |
-
#
|
35 |
# -------------------------
|
36 |
-
def
|
37 |
"""
|
38 |
-
Search UMLS for a
|
39 |
"""
|
40 |
tgt = get_tgt()
|
41 |
-
|
|
|
42 |
params = {
|
43 |
"string": term,
|
44 |
-
"ticket":
|
45 |
-
"pageSize":
|
46 |
}
|
47 |
-
r = requests.get(f"{UMLS_BASE}/search/current", params=params)
|
48 |
r.raise_for_status()
|
49 |
data = r.json()
|
50 |
|
51 |
results = []
|
52 |
-
for
|
53 |
results.append({
|
54 |
-
"ui":
|
55 |
-
"name":
|
56 |
-
"rootSource":
|
57 |
})
|
58 |
return results
|
59 |
|
60 |
def get_cui_details(cui: str) -> Dict:
|
61 |
"""
|
62 |
-
Retrieve
|
63 |
"""
|
64 |
tgt = get_tgt()
|
65 |
-
|
66 |
-
|
67 |
-
|
|
|
68 |
r.raise_for_status()
|
69 |
return r.json()
|
70 |
|
71 |
-
def
|
72 |
"""
|
73 |
-
Get
|
|
|
74 |
"""
|
75 |
tgt = get_tgt()
|
76 |
-
|
77 |
-
|
78 |
-
|
|
|
|
|
|
|
|
|
79 |
r.raise_for_status()
|
80 |
data = r.json()
|
81 |
|
82 |
-
|
83 |
for rel in data.get("result", []):
|
84 |
-
|
85 |
-
|
86 |
-
|
87 |
-
|
88 |
-
|
89 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
# genesis/api_clients/umls_api.py
|
2 |
import os
|
3 |
import requests
|
4 |
+
from typing import Dict, List, Optional
|
5 |
|
6 |
+
UMLS_API_KEY = os.getenv("UMLS_API_KEY")
|
7 |
+
UMLS_BASE = "https://uts-ws.nlm.nih.gov"
|
8 |
+
|
9 |
+
if not UMLS_API_KEY:
|
10 |
+
raise EnvironmentError("Missing UMLS_API_KEY in environment variables.")
|
11 |
|
12 |
# -------------------------
|
13 |
# AUTHENTICATION
|
14 |
# -------------------------
|
15 |
def get_tgt() -> str:
|
16 |
"""
|
17 |
+
Get a Ticket Granting Ticket (TGT) from UMLS.
|
18 |
"""
|
19 |
+
r = requests.post(
|
20 |
+
f"{UMLS_BASE}/restful/isValidService",
|
21 |
+
data={"apikey": UMLS_API_KEY}
|
22 |
+
)
|
23 |
+
if r.status_code != 201:
|
24 |
+
raise Exception(f"Failed to get UMLS TGT: {r.text}")
|
25 |
+
return r.headers.get("location")
|
26 |
|
27 |
+
def get_service_ticket(tgt: str) -> str:
|
28 |
"""
|
29 |
+
Get a single-use Service Ticket from the TGT.
|
30 |
"""
|
31 |
+
r = requests.post(tgt, data={"service": "http://umlsks.nlm.nih.gov"})
|
|
|
32 |
r.raise_for_status()
|
33 |
return r.text
|
34 |
|
35 |
# -------------------------
|
36 |
+
# CORE FUNCTIONS
|
37 |
# -------------------------
|
38 |
+
def search_cui(term: str, page_size: int = 10) -> List[Dict]:
|
39 |
"""
|
40 |
+
Search for UMLS CUIs for a given term.
|
41 |
"""
|
42 |
tgt = get_tgt()
|
43 |
+
ticket = get_service_ticket(tgt)
|
44 |
+
|
45 |
params = {
|
46 |
"string": term,
|
47 |
+
"ticket": ticket,
|
48 |
+
"pageSize": page_size
|
49 |
}
|
50 |
+
r = requests.get(f"{UMLS_BASE}/rest/search/current", params=params)
|
51 |
r.raise_for_status()
|
52 |
data = r.json()
|
53 |
|
54 |
results = []
|
55 |
+
for result in data.get("result", {}).get("results", []):
|
56 |
results.append({
|
57 |
+
"ui": result.get("ui"),
|
58 |
+
"name": result.get("name"),
|
59 |
+
"rootSource": result.get("rootSource")
|
60 |
})
|
61 |
return results
|
62 |
|
63 |
def get_cui_details(cui: str) -> Dict:
|
64 |
"""
|
65 |
+
Retrieve detailed information about a specific CUI.
|
66 |
"""
|
67 |
tgt = get_tgt()
|
68 |
+
ticket = get_service_ticket(tgt)
|
69 |
+
|
70 |
+
params = {"ticket": ticket}
|
71 |
+
r = requests.get(f"{UMLS_BASE}/rest/content/current/CUI/{cui}", params=params)
|
72 |
r.raise_for_status()
|
73 |
return r.json()
|
74 |
|
75 |
+
def get_related_concepts(cui: str, relation_type: str = "RO") -> List[Dict]:
|
76 |
"""
|
77 |
+
Get related concepts for a given CUI.
|
78 |
+
relation_type: 'RO' (related other), 'RQ' (related and qualified), etc.
|
79 |
"""
|
80 |
tgt = get_tgt()
|
81 |
+
ticket = get_service_ticket(tgt)
|
82 |
+
|
83 |
+
params = {"ticket": ticket}
|
84 |
+
r = requests.get(
|
85 |
+
f"{UMLS_BASE}/rest/content/current/CUI/{cui}/relations",
|
86 |
+
params=params
|
87 |
+
)
|
88 |
r.raise_for_status()
|
89 |
data = r.json()
|
90 |
|
91 |
+
related = []
|
92 |
for rel in data.get("result", []):
|
93 |
+
if rel.get("relationLabel") == relation_type:
|
94 |
+
related.append({
|
95 |
+
"cui": rel.get("relatedIdName"),
|
96 |
+
"name": rel.get("relatedIdName"),
|
97 |
+
"relation": rel.get("relationLabel")
|
98 |
+
})
|
99 |
+
return related
|
100 |
+
|
101 |
+
def link_to_bioportal(cui: str) -> str:
|
102 |
+
"""
|
103 |
+
Construct a BioPortal link for the given CUI.
|
104 |
+
"""
|
105 |
+
return f"https://bioportal.bioontology.org/search?query={cui}"
|