Spaces:
Sleeping
Sleeping
File size: 48,856 Bytes
b92b744 9178ee1 b92b744 9178ee1 b92b744 57a9a08 b92b744 86c2108 b92b744 86c2108 b92b744 d2f845c b92b744 57a9a08 b92b744 57a9a08 b92b744 9178ee1 285b041 9178ee1 b92b744 a4e23c3 285b041 a4e23c3 b92b744 86c2108 b92b744 86c2108 b92b744 d2f845c b92b744 9178ee1 b92b744 d2f845c b92b744 d2f845c b92b744 d2f845c b92b744 d2f845c b92b744 57a9a08 b92b744 9178ee1 b92b744 | 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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 | """The online pipeline: parse → retrieve/expand → extract/cache → aggregate → plan."""
import asyncio
import logging
import math
from collections import Counter
from datetime import UTC, datetime
from time import perf_counter
from uuid import uuid4
from app.concepts import aim
from app.config import Settings, settings
from app.fulltext import FullTextClient
from app.llm import LLMService, Usage
from app.models import ConceptSteer, Pico, SearchRequest
from app.repository import (
BUCKETS,
EFFECT_DIRECTIONS,
ElasticRepository,
filter_clauses,
lexical_query,
population_query,
registry_citation_exemption_query,
rrf_fuse,
)
from app.statistics import INCONCLUSIVE_REASONS, analyze_studies, assign_bucket
logger = logging.getLogger(__name__)
_REASON_PHRASES = {
"wide_interval": "had an interval too wide to separate no effect from a meaningful one",
"mixed_result": "reported conflicting primary results",
"no_result": "had no readable comparative result",
"other_scale": "reported on a scale that cannot be compared with this threshold",
"no_threshold": "could not be compared without a valid threshold",
}
def inconclusive_sentence(count: int, reasons: dict | None) -> str:
"""Inconclusive is mostly a statement about what could be read, so say which."""
if not count:
return ""
parts = [
f"{reasons[key]} {phrase}"
for key, phrase in _REASON_PHRASES.items()
if reasons and reasons.get(key)
]
detail = f": {'; '.join(parts)}" if parts else ""
return f"A further {count} are inconclusive{detail}. "
def filter_phrases(filters: dict) -> list[str]:
"""Plain descriptions of the active corpus filters, for warnings and scope text."""
phrases = []
year_from, year_to = filters.get("yearFrom"), filters.get("yearTo")
if year_from is not None and year_to is not None:
phrases.append(f"published {year_from}–{year_to}")
elif year_from is not None:
phrases.append(f"published in {year_from} or later")
elif year_to is not None:
phrases.append(f"published in {year_to} or earlier")
low, high = filters.get("minCitations"), filters.get("maxCitations")
if low is not None and high is not None:
phrases.append(f"cited {low} to {high} times")
elif low is not None:
phrases.append(f"cited at least {low} times")
elif high is not None:
phrases.append(f"cited at most {high} times")
return phrases
# The registry sweep can fill the first several dozen ranks with trials, so the screen has to
# reach well past the displayed page or papers are cut before anyone judges them.
SCREEN_LIMIT = 500
SCREEN_BATCH = 40
# A full screen is 13 calls; an unbounded burst risks a rate limit, which fails open to
# unscreened results.
SCREEN_CONCURRENCY = 8
def rules_pico_changes(
pursuit: dict, sparse_populations: list[str], null_terms: list[dict]
) -> tuple[list[dict], str]:
"""Fixed-rule PICO suggestion: at most one change, only where the record points somewhere."""
state = pursuit["state"]
if state == "favours_null" and sparse_populations:
return [
{
"field": "population",
"to": sparse_populations[0],
"reason": "Rarely studied among the matches, while the asked population "
"already leans towards no effect.",
}
], (
"The record leans towards no effect in the asked population; a population the "
"matches barely cover is where a new study could still change the answer."
)
if state == "favours_null" and null_terms:
return [], (
f"The record leans towards no effect. Abstracts reporting nulls over-represent "
f"'{null_terms[0]['term']}'; reconsider that element of the design before repeating it."
)
if state == "contested":
return [], (
"Studies disagree. Keep the intervention and comparator but narrow the population "
"or fix one outcome definition, so the new study can say when the effect appears."
)
if state == "favours_effect":
return [], (
"The record already leans towards a real effect; extend it (a new population, a "
"longer follow-up or a harder outcome) rather than repeating the same comparison."
)
return [], "The question is unsettled as posed; no change to the PICO is indicated."
def recount(studies: list[dict], sesoi: float, effect_type: str) -> dict:
"""Bucket counts over screened studies, replacing the keyword-match aggregation."""
counts = dict.fromkeys(BUCKETS, 0)
reasons = dict.fromkeys(INCONCLUSIVE_REASONS, 0)
directions = dict.fromkeys(EFFECT_DIRECTIONS.values(), 0)
for study in studies:
verdict = assign_bucket(study, sesoi, effect_type)
counts[verdict["bucket"]] += 1
if verdict["inconclusive_reason"]:
reasons[verdict["inconclusive_reason"]] += 1
if verdict["bucket"] == "effect":
key = study.get("result_direction") or "unclear"
directions[EFFECT_DIRECTIONS.get(key, "unclear")] += 1
return {
"total": len(studies),
"bucketCounts": counts,
"inconclusiveReasons": reasons,
"effectDirections": directions,
}
def to_paper(study: dict, sesoi: float, effect_type: str) -> dict:
verdict = assign_bucket(study, sesoi, effect_type)
effect = None
if study.get("estimate") is not None and study.get("effect_type"):
effect = {"metric": study["effect_type"], "value": study["estimate"]}
if study.get("ci_low") is not None and study.get("ci_high") is not None:
effect["ci"] = [study["ci_low"], study["ci_high"]]
nct_ids = study.get("nct_ids", [])
links = [f"https://clinicaltrials.gov/study/{nct}" for nct in nct_ids]
links += [f"https://pubmed.ncbi.nlm.nih.gov/{pmid}/" for pmid in study.get("pmids", [])]
links += [p["url"] for p in study.get("linked_papers", []) if p.get("url")]
return {
"id": study["id"],
"title": study.get("title", ""),
"authors": study.get("authors", []),
"year": study.get("year") or 0,
"venue": study.get("venue"),
"source": "clinicaltrials"
if study.get("source") == "ctgov"
else study.get("source", "openalex"),
"url": study.get("url") or (links[0] if links else ""),
"citations": study.get("cited_by_count", 0),
"abstractAvailable": study.get("abstract_available"),
"workType": study.get("work_type"),
"snapshotDate": (study.get("snapshot_provenance") or {}).get("snapshot_date"),
"verdict": verdict["bucket"],
"rationale": verdict["rationale"],
"inconclusiveReason": verdict["inconclusive_reason"],
"resultDirection": study.get("result_direction"),
"sampleSize": study.get("n"),
"effectSize": effect,
"evidenceSpan": study.get("evidence_span", ""),
"numericSource": study.get("numeric_source"),
"evidenceTier": verdict["evidence_tier"],
"mde": verdict["mde"],
"pValue": study.get("p_value"),
"whyStopped": study.get("why_stopped"),
"nctIds": nct_ids,
"pmids": study.get("pmids", []),
"significantButTrivial": verdict["significant_but_trivial"],
"linkedUrls": list(dict.fromkeys(links)),
"numericNotes": verdict.get("numeric_notes", []),
"analysisEffectSize": (
{
"metric": verdict["analysis_effect_type"],
"value": verdict["analysis_estimate"],
"ci": verdict["analysis_ci"],
}
if verdict.get("analysis_estimate") is not None and verdict.get("analysis_ci")
else None
),
"extractionEvidence": study.get("extraction_evidence", {}),
"extractionSource": study.get("extraction_source"),
"pmcid": study.get("pmcid"),
"ciLevel": study.get("ci_level"),
"pValueOperator": study.get("p_value_operator"),
"analysisEffectType": verdict.get("analysis_effect_type"),
"primaryOutcome": study.get("outcome") or "",
"outcomeUnit": study.get("outcome_unit") or "",
}
class SearchPipeline:
def __init__(
self,
repository: ElasticRepository,
llm: LLMService,
config: Settings = settings,
embedder=None,
fulltext: FullTextClient | None = None,
):
self.repo, self.llm, self.config = repository, llm, config
self.embedder = embedder
self.fulltext = fulltext or FullTextClient(config)
# Single API process shares document locks; concurrent warm-up pays once per work.
self.locks: dict[str, asyncio.Lock] = {}
self.active = asyncio.Semaphore(config.max_concurrent_searches)
async def embed(self, text: str) -> list[float] | None:
if not self.config.embeddings_enabled:
return None
if self.embedder is None:
from app.embeddings import get_embedder
self.embedder = get_embedder(self.config.embedding_model, self.config.embedding_device)
return await asyncio.to_thread(self.embedder.embed_query, text)
async def aim(
self, vector: list[float] | None, steer: ConceptSteer, warnings: list[str]
) -> list[float] | None:
"""Move the question's vector towards the kept concepts and away from the pushed ones.
The tags change ranking, never the match set: the lexical query is
untouched, so a search with tags returns the question's studies in a
different order rather than a different search's studies.
"""
if vector is None:
warnings.append(
"Concept tags need embeddings to steer ranking, and embeddings are "
"unavailable here, so the tags were ignored."
)
return None
terms = list(dict.fromkeys([*steer.positive, *steer.negative]))
try:
embedded = await asyncio.gather(*(self.embed(term) for term in terms))
except Exception as exc:
logger.warning("Concept embedding unavailable: %s", type(exc).__name__)
warnings.append("The concept tags could not be embedded, so ranking was not steered.")
return vector
by_term = dict(zip(terms, embedded))
if any(by_term[term] is None for term in terms):
warnings.append("The concept tags could not be embedded, so ranking was not steered.")
return vector
steered = aim(
vector,
[by_term[term] for term in steer.positive],
[by_term[term] for term in steer.negative],
)
if steered is None:
warnings.append(
"The concept tags canceled the question out, leaving no direction to "
"search in, so ranking was not steered."
)
return vector
return steered
async def expand(
self,
hits: list[dict],
vector: list[float] | None,
warnings: list[str],
pico: dict | None = None,
filters: dict | None = None,
) -> list[dict]:
if vector is None:
return []
reviews = [d for d in hits if d.get("is_review")][:3]
if any(not review.get("referenced_works") for review in reviews):
warnings.append(
"Some indexed reviews lack reference lists, limiting reference discovery."
)
references = list(
dict.fromkeys(ref for review in reviews for ref in review.get("referenced_works", []))
)[:180]
if not references:
return []
indexed = await self.repo.get_many(references)
known = {d["id"] for d in indexed}
missing = [ref for ref in references if ref not in known]
if missing:
warnings.append(
f"{len(missing)} review references are outside the loaded snapshot index. "
"Reference discovery is limited to the imported records."
)
canonical_ids = list(
dict.fromkeys(
identifier
for doc in indexed
if doc.get("record_kind") == "linked_publication"
for identifier in doc.get("canonical_ids", [])
)
)
canonical = await self.repo.get_many(canonical_ids) if canonical_ids else []
indexed = list(
{
doc["id"]: doc
for doc in [*indexed, *canonical]
if doc.get("record_kind") != "linked_publication"
}.values()
)
norm = math.sqrt(sum(x * x for x in vector))
ranked = []
for doc in indexed:
embedding = doc.get("embedding")
if not embedding:
embedding = await self.embed(doc.get("abstract") or doc.get("title", ""))
if embedding and len(embedding) == len(vector):
denom = norm * math.sqrt(sum(x * x for x in embedding))
similarity = sum(a * b for a, b in zip(vector, embedding)) / denom if denom else 0
if similarity >= self.config.reference_min_similarity:
ranked.append((similarity, doc))
# Expanded references skip the lexical query, so the population guard and the
# corpus filters have to be reapplied here or the study list would show rows
# the aggregation over the same query already excluded.
if ranked and (population_query(pico or {}) is not None or filter_clauses(filters)):
eligible_ids = await self.repo.screen_population(
[doc["id"] for _, doc in ranked], pico or {}, filters
)
ranked = [(score, doc) for score, doc in ranked if doc["id"] in eligible_ids]
return [doc for _, doc in sorted(ranked, key=lambda pair: -pair[0])]
async def extract_one(self, study: dict, usage: Usage, warnings: list[str]) -> dict:
if study.get("is_review"):
return study
if not study.get("abstract") and not self.fulltext.pmcid(study):
return study
# Registry primary-outcome numbers are authoritative; papers cannot overwrite them.
if study.get("source") == "ctgov" or (
study.get("source") == "merged"
and any(study.get(k) is not None for k in ("estimate", "ci_low", "p_value"))
):
return study
lock = self.locks.setdefault(study["id"], asyncio.Lock())
async with lock:
current = await self.repo.get(study["id"]) or study
fresh = bool(current.get("extracted_at")) and (
current.get("extraction_version") == self.config.extraction_cache_version
)
# Full text is a lazy upgrade: an abstract-only cache is re-read once when Europe
# PMC has the paper. A recorded 'used' or 'unavailable' verdict is never re-fetched.
upgrade = (
self.config.fulltext_enabled
and self.fulltext.pmcid(current) is not None
and current.get("fulltext_status") not in ("used", "unavailable")
)
if fresh and not upgrade:
usage.extraction_cache_hits += 1
if current.get("extraction_status") == "rejected":
warnings.append(
"A cached extraction failed evidence validation; that study remains text only."
)
if current.get("extraction_status") == "retained_verified":
warnings.append(
"A newer extraction failed verification; this study uses its previous verified facts."
)
return current
if not self.config.openai_api_key:
return current
lines, status = (None, None)
if self.config.fulltext_enabled:
lines, status = await self.fulltext.lines(current)
if status == "error":
warnings.append(
"Full text could not be fetched for some open-access papers; their abstracts were used."
)
if fresh:
usage.extraction_cache_hits += 1
return current
if fresh and status == "unavailable":
# Nothing beyond the abstract exists; record that so the fetch is not repeated.
await self.repo.cache_extraction(study["id"], {"fulltext_status": "unavailable"})
usage.extraction_cache_hits += 1
return dict(current, fulltext_status="unavailable")
if not lines and not current.get("abstract"):
return current
try:
extraction = (
await self.llm.extract(current, usage, lines=lines)
if lines
else await self.llm.extract(current, usage)
)
except ValueError:
extraction = {
"extracted_at": datetime.now(UTC).isoformat(),
"extraction_version": self.config.extraction_cache_version,
"extraction_status": "rejected",
"extraction_source": "full_text" if lines else "abstract",
}
if current.get("extraction_status") in ("verified", "retained_verified"):
extraction["extraction_status"] = "retained_verified"
extraction["extraction_facts_version"] = current.get(
"extraction_facts_version", current.get("extraction_version")
)
extraction["extraction_source"] = current.get("extraction_source")
warnings.append(
"A new extraction failed verification; the previous verified facts were retained."
)
else:
warnings.append(
"An extraction failed verbatim evidence validation and was excluded."
)
except Exception as exc:
logger.warning("Extraction unavailable: %s", type(exc).__name__)
warnings.append(
"Some paper extractions were unavailable; source classifications remain visible."
)
return current
if status in ("used", "unavailable"):
extraction["fulltext_status"] = status
# Never replace trusted registry PICO fields with absent extraction fields.
updated = dict(current, **extraction)
extraction.update(assign_bucket(updated))
await self.repo.cache_extraction(study["id"], extraction)
return dict(current, **extraction)
async def screen(
self, question: dict, studies: list[dict], usage: Usage, warnings: list[str]
) -> tuple[list[dict], dict | None]:
"""Drop keyword matches that do not address the question, before paying to read them.
Sharing words with the question is not relevance ("creatine kinase" in a
hypertension paper is not creatine supplementation). Fails open: if the screen
is unavailable every match is kept and the result says so.
"""
if not studies or not self.config.openai_api_key:
return studies, None
head = studies[:SCREEN_LIMIT]
rows = [
{
"id": d["id"],
"title": (d.get("title") or "")[:200],
"population": (d.get("population") or "")[:120],
"intervention": (d.get("intervention") or "")[:120],
"outcome": (d.get("outcome") or "")[:120],
"abstract": (d.get("abstract") or "")[:280],
}
# Batch by id, not by rank: a study's verdict should not depend on which
# neighbors the ranking happened to put beside it. `kept` restores rank order.
for d in sorted(head, key=lambda d: d["id"])
]
slots = asyncio.Semaphore(SCREEN_CONCURRENCY)
async def screen_batch(batch: list[dict]) -> set[str]:
async with slots:
return await self.llm.screen(question, batch, usage)
try:
batches = await asyncio.gather(
*(
screen_batch(rows[start : start + SCREEN_BATCH])
for start in range(0, len(rows), SCREEN_BATCH)
)
)
relevant = set().union(*batches)
except Exception as exc:
logger.warning("Relevance screening unavailable: %s", type(exc).__name__)
warnings.append(
"Relevance screening was unavailable; results are keyword matches and may "
"include studies that do not address the question."
)
return studies, None
kept = [d for d in head if d["id"] in relevant]
return kept, {
"screened": len(head),
"relevant": len(kept),
"complete": len(head) == len(studies),
}
async def group_outcomes(
self, question: dict, studies: list[dict], verdicts: dict, usage: Usage, warnings: list[str]
) -> dict[str, str]:
"""Ask which numeric studies measure the same thing; pooling itself stays in code.
Exact outcome wording almost never repeats across reports, so without this no
pool forms. Only studies that already have a usable standard error are sent.
"""
rows = [
{
"id": d["id"],
"outcome": d.get("outcome") or "",
"unit": d.get("outcome_unit") or "",
"intervention": d.get("intervention") or "",
"comparator": d.get("comparator") or "",
"scale": verdicts[d["id"]]["analysis_effect_type"],
}
for d in studies
if verdicts[d["id"]]["analysis_se"] is not None
and verdicts[d["id"]]["bucket"] not in {"failed", "unreported"}
and d.get("outcome")
]
if len(rows) < 3 or not self.config.openai_api_key:
return {}
try:
return await self.llm.group_outcomes(question, rows, usage)
except Exception as exc:
logger.warning("Outcome grouping unavailable: %s", type(exc).__name__)
warnings.append(
"Outcome grouping was unavailable; only studies with identical outcome "
"wording could be pooled."
)
return {}
async def overview(
self, question: dict, studies: list[dict], verdicts: dict, usage: Usage, warnings: list[str]
) -> dict | None:
"""Generated account of what the matches are, from extracted facts and verdicts only."""
if not studies or not self.config.openai_api_key:
return None
rows = [
{
"id": d["id"],
"title": (d.get("title") or "")[:200],
"source": "registry" if d.get("source") in ("ctgov", "merged") else "paper",
"design": (d.get("design") or d.get("study_design") or "")[:120],
"population": (d.get("population") or "")[:160],
"intervention": (d.get("intervention") or "")[:160],
"comparator": (d.get("comparator") or "")[:120],
"outcome": (d.get("outcome") or "")[:200],
"hasControlArm": d.get("has_control"),
"registryStatus": d.get("overall_status"),
"verdict": verdicts[d["id"]]["bucket"],
"why": verdicts[d["id"]]["rationale"],
}
for d in studies[:12]
]
try:
result = await self.llm.overview({"question": question, "rows": rows}, usage)
except Exception as exc:
logger.warning("Overview unavailable: %s", type(exc).__name__)
warnings.append("The generated overview of matched studies was unavailable.")
return None
titles = {row["id"]: row["title"] for row in rows}
return {
"summary": result.summary,
"notes": [
{"id": item.id, "title": titles[item.id], "note": item.note}
for item in result.notes
],
"scope": f"Generated from the extracted facts and verdicts of the {len(rows)} "
"matched studies read in detail; it introduces no findings or numbers of its own.",
}
async def recommend_pico(
self,
pico: Pico,
pursuit: dict,
studies: list[dict],
verdicts: dict,
aggregation: dict,
alternatives: list[dict],
usage: Usage,
warnings: list[str],
) -> dict:
"""The PICO a new study should ask, given the record: model-written when available.
Without a model (or when it fails) the rules fallback names the one change the
record itself supports, so the block never invents a design from nothing.
"""
recommended = {
key: getattr(pico, key)
for key in ("population", "intervention", "comparator", "outcome")
}
sparse = [alt["label"] for alt in alternatives if not alt["label"].startswith("Reconsider")]
result = None
if studies and self.config.openai_api_key:
rows = [
{
"id": d["id"],
"population": (d.get("population") or "")[:160],
"intervention": (d.get("intervention") or "")[:160],
"comparator": (d.get("comparator") or "")[:120],
"outcome": (d.get("outcome") or "")[:200],
"verdict": verdicts[d["id"]]["bucket"],
}
for d in studies[:12]
]
table = {
"pico": recommended,
"record": {
key: pursuit[key] for key in ("state", "pEffect", "recommendation", "reasons")
}
| {
"nullTerms": [term["term"] for term in aggregation["nullTerms"][:5]],
"sparsePopulations": sparse[:3],
},
"rows": rows,
}
try:
result = await self.llm.recommend_pico(table, usage)
except Exception as exc:
logger.warning("PICO recommendation unavailable: %s", type(exc).__name__)
warnings.append(
"The generated PICO recommendation was unavailable; the suggestion below "
"follows fixed rules."
)
if result is not None:
changes = [change.model_dump() for change in result.changes]
rationale, source = result.rationale, "model"
else:
changes, rationale = rules_pico_changes(pursuit, sparse, aggregation["nullTerms"])
source = "rules"
for change in changes:
recommended[change["field"]] = change["to"]
return {
"pico": recommended,
"changes": changes,
"rationale": rationale,
"source": source,
}
async def effect_trend(
self,
idea: str,
studies: list[dict],
verdicts: dict,
aggregation: dict,
stats: dict,
usage: Usage,
warnings: list[str],
) -> dict | None:
"""What the studies reporting an effect have in common; tallies are counted here."""
effects = [d for d in studies if verdicts[d["id"]]["bucket"] == "effect"]
if not effects:
return None
directions = Counter(d.get("result_direction") or "unclear" for d in effects)
counts = aggregation["bucketCounts"]
trend = {
"studied": len(effects),
"totalEffects": counts["effect"],
"favoursIntervention": directions["favours_intervention"],
"favoursComparator": directions["favours_comparator"],
"unclear": directions["unclear"],
"summary": None,
"patterns": [],
"scope": f"Based on the {len(effects)} effect-reporting studies read in detail, of "
f"{counts['effect']} in the full match set.",
}
if len(effects) < 2 or not self.config.openai_api_key:
return trend
rows = []
for d in effects[:20]:
verdict = verdicts[d["id"]]
evidence = d.get("extraction_evidence") or {}
rows.append(
{
"id": d["id"],
"population": (d.get("population") or "")[:160],
"intervention": (d.get("intervention") or "")[:160],
"comparator": (d.get("comparator") or "")[:160],
"outcome": (d.get("outcome") or "")[:200],
"unit": d.get("outcome_unit") or "",
"n": d.get("n"),
"direction": d.get("result_direction") or "unclear",
"estimate": d.get("estimate"),
"scale": d.get("effect_type"),
"tier": verdict["evidence_tier"],
"quote": (
evidence.get("reported_result")
or evidence.get("result_direction")
or d.get("evidence_span")
or ""
)[:320],
}
)
try:
narrative = await self.llm.trend(
{
"question": idea,
"rows": rows,
"pools": [
{key: pool[key] for key in ("outcome", "effectType", "k", "estimate", "ci")}
for pool in stats.get("pools", [])
],
"context": {
"effectStudiesInTable": len(rows),
"effectStudiesInFullMatchSet": counts["effect"],
"reportedNulls": counts["credible_null"] + counts.get("reported_null", 0),
"unreportedTrials": counts["unreported"],
"directionTally": dict(directions),
},
},
usage,
)
trend.update(summary=narrative.summary, patterns=narrative.patterns)
except Exception as exc:
logger.warning("Effect trend unavailable: %s", type(exc).__name__)
warnings.append("The effect-trend summary was unavailable; direction counts are shown.")
return trend
async def corpus_filters(
self,
filters: dict,
unfiltered_query: dict,
filtered_query: dict,
matched: int,
warnings: list[str],
) -> dict:
"""Report what the pre-search filters removed, and that the counts are a subset.
The excluded figure is one Elasticsearch count over the same match-set
predicate without the filter clauses; when it is unavailable the report
says so rather than implying nothing was removed.
"""
phrases = filter_phrases(filters)
total = None
try:
total = await self.repo.count_studies(unfiltered_query)
except Exception as exc:
logger.warning("Unfiltered match count unavailable: %s", type(exc).__name__)
excluded = max(total - matched, 0) if total is not None else None
detail = (
f" They excluded {excluded} of {total} otherwise-matching indexed studies."
if excluded is not None
else " How many records they excluded could not be counted."
)
warnings.append(
f"Your corpus filters ({'; '.join(phrases)}) were applied before the search, so every "
"count, bucket share, histogram and file-drawer figure here describes that filtered "
f"subset of the index rather than all matching evidence.{detail}"
)
exemption = registry_citation_exemption_query(filtered_query, filters)
exempted = None
if exemption is not None:
try:
exempted = await self.repo.count_studies(exemption)
except Exception as exc:
logger.warning("Registry exemption count unavailable: %s", type(exc).__name__)
count = f"{exempted} matching registry rows are" if exempted is not None else "They are"
warnings.append(
f"ClinicalTrials.gov records carry no citation count, so {count} kept despite the "
"citation bounds. Filtering on citations would otherwise remove the terminated and "
"never-reported trials this search exists to surface."
)
if filters.get("yearFrom") is not None or filters.get("yearTo") is not None:
warnings.append(
"Records with no publication date cannot satisfy a publication-year filter and "
"were excluded; for registry rows that date is the trial's primary completion date."
)
bounds = ("yearFrom", "yearTo", "minCitations", "maxCitations")
return {
**{key: filters.get(key) for key in bounds},
"description": phrases,
"registryCitationExemption": exemption is not None,
# Registry rows the citation bound would have removed had it applied to them.
"registryExempted": exempted,
"matchedBeforeFilters": total,
"excluded": excluded,
}
async def search(self, request: SearchRequest, progress=None) -> dict:
async with self.active:
return await self._search(request, progress)
async def _search(self, request: SearchRequest, progress=None) -> dict:
started = perf_counter()
warnings: list[str] = []
usage = Usage()
async def emit(stage: str, message: str, scanned: int | None = None):
if progress:
await progress(
{
"stage": stage,
"message": message,
**({"scanned": scanned} if scanned is not None else {}),
}
)
await self.repo.ensure_index()
await emit("keywords", "Parsing population, intervention, comparison, and outcome")
try:
pico = await self.llm.parse(request, usage)
except Exception as exc:
logger.warning("PICO parsing unavailable: %s", type(exc).__name__)
pico = Pico(
population="",
intervention=request.idea,
comparator="",
outcome="",
synonyms=[],
studyDesigns=[],
sesoi=request.sesoi or 0.2,
sesoiRationale="Fallback planning assumption; set a domain-appropriate threshold.",
effectType=request.effectType,
)
warnings.append(
"PICO parsing was unavailable. Search uses your original wording and selected planning values."
)
await emit("searching", "Retrieving indexed papers and registered trials")
# A filter set with no bound is not a filter: it must not warn or cost a count.
filters = (
request.filters.model_dump()
if request.filters is not None and request.filters.active
else None
)
query = lexical_query(pico.model_dump(), request.idea, filters=filters)
try:
vector = await self.embed(request.idea)
except Exception as exc:
vector = None
logger.warning("Local embeddings unavailable: %s", type(exc).__name__)
warnings.append("Local embeddings are unavailable; retrieval used BM25 keyword search.")
steer = request.concepts if request.concepts and request.concepts.active else None
if steer:
vector = await self.aim(vector, steer, warnings)
hits, mode = await self.repo.retrieve(query, vector)
expanded = await self.expand(hits, vector, warnings, pico.model_dump(), filters)
expansion_ids = [d["id"] for d in expanded]
if expanded:
query = lexical_query(pico.model_dump(), request.idea, expansion_ids, filters=filters)
hits = rrf_fuse(hits, expanded)
registry = await self.repo.registry_sweep(query)
hits = rrf_fuse(hits, registry)
# Link across retrieved source records, preserving one canonical row per registered trial.
from app.ingest.linker import link_studies
hits = link_studies(hits)
# Linking is normally offline; newly discovered links must also update global counts.
merged = [d for d in hits if d.get("source") == "merged"]
if merged:
await self.repo.persist_links(merged)
expansion_ids = expansion_ids + [d["id"] for d in merged]
query = lexical_query(
pico.model_dump(),
request.idea,
expansion_ids,
filters=filters,
)
studies = [d for d in hits if not d.get("is_review")]
question = {
"idea": request.idea,
"population": pico.population,
"intervention": pico.intervention,
"comparator": pico.comparator,
"outcome": pico.outcome,
}
studies, screening = await self.screen(question, studies, usage, warnings)
await emit(
"classifying",
"Loading cached numbers and verifying uncached evidence spans",
len(studies),
)
targets = [d for d in studies if d.get("source") in ("openalex", "merged")][
: self.config.extraction_limit
]
extracted = await asyncio.gather(*(self.extract_one(d, usage, warnings) for d in targets))
by_id = {d["id"]: d for d in extracted}
studies = [by_id.get(d["id"], d) for d in studies]
await emit(
"estimating", "Aggregating every match and calculating study assurance", len(studies)
)
aggregation = await self.repo.aggregate(query, pico.sesoi, pico.effectType)
count_scope = (
"All indexed lexical matches plus screened review references; reviews excluded. "
"Planning uses compatible studies among the top retrieved results."
)
# Complete only if the screened page was the whole match set, not its first page.
if screening:
screening["complete"] = (
screening["complete"] and aggregation["total"] <= screening["screened"]
)
if screening and screening["complete"]:
# Every lexical match was screened, so the counts can describe relevant studies only.
aggregation.update(recount(studies, pico.sesoi, pico.effectType))
count_scope = (
f"All {screening['screened']} keyword matches were screened for relevance; counts "
f"cover the {screening['relevant']} that address the question. Reviews excluded."
)
elif screening:
warnings.append(
f"Counts cover all {aggregation['total']} keyword matches, but only the top "
f"{screening['screened']} were screened for relevance ({screening['relevant']} "
"judged relevant), so the counts include studies that may not address the question."
)
applied_filters = None
if filters:
applied_filters = await self.corpus_filters(
filters,
lexical_query(pico.model_dump(), request.idea, expansion_ids or None),
query,
aggregation["total"],
warnings,
)
count_scope += (
f" Restricted before searching to studies {'; '.join(filter_phrases(filters))}."
)
plan = request.model_dump()
plan.update(sesoi=pico.sesoi, effectType=pico.effectType)
verdicts = {d["id"]: assign_bucket(d, pico.sesoi, pico.effectType) for d in studies}
outcome_groups = await self.group_outcomes(question, studies, verdicts, usage, warnings)
stats = await asyncio.to_thread(
analyze_studies, studies, plan, aggregation["fileDrawer"], outcome_groups
)
warnings.extend(stats.get("warnings", []))
effect_trend = await self.effect_trend(
request.idea, studies, verdicts, aggregation, stats, usage, warnings
)
overview = None
if not (effect_trend and effect_trend["summary"]):
# No trend to describe: say instead what the matches are and why none answers it.
overview = await self.overview(question, studies, verdicts, usage, warnings)
controlled = sum(d.get("has_control") is True for d in studies)
if mode == "bm25" and not any("BM25" in warning for warning in warnings):
warnings.append(
"This deployment is configured for BM25 retrieval; enable local embeddings for hybrid search."
)
if aggregation["total"] == 0:
summary = "No indexed primary studies matched this question. Try narrower intervention and outcome terms, or ingest more source records. This is a coverage gap, not evidence of no effect."
elif not studies:
summary = f"{aggregation['total']} indexed primary studies matched, but only reviews reached the retrieved page. Narrow the query to inspect primary evidence; no planning estimate is available from this page."
else:
c = aggregation["bucketCounts"]
summary = (
f"The full indexed match set contains {aggregation['total']} primary studies: "
f"{c['effect']} reported effects, {c['credible_null']} credible nulls, "
f"{c.get('reported_null', 0)} reported nulls of unverified magnitude, "
f"{c['failed']} methodological failures, "
f"and {c['unreported']} overdue unreported trials. "
+ inconclusive_sentence(c["inconclusive"], aggregation.get("inconclusiveReasons"))
+ "Text-only classifications do not establish meaningful effect size. "
)
drivers = stats.get("warnings", [])[:4]
if studies and stats.get("assurance") is None:
summary += " A compatible numerical evidence pool for this study plan is unavailable, so assurance and expected value are not estimated. Missing reports have unknown outcomes."
# Insufficient evidence gets deterministic narration. A model must not turn
# a classifier-only positive or another endpoint into a compatible result.
if studies and self.config.openai_api_key and stats.get("assurance") is not None:
try:
narrative = await self.llm.narrate(
{
"counts": aggregation["bucketCounts"],
"matched": aggregation["total"],
"scope": "Full lexical matches plus relevance-screened review references; planning uses top retrieved compatible studies.",
"sesoi": pico.sesoi,
"scale": pico.effectType,
"assurance": stats.get("assurance"),
"fileDrawer": stats.get("fileDrawer"),
"pooledGroups": len(stats.get("pools", [])),
"warnings": stats.get("warnings", []),
"rows": [
{
"id": d["id"],
"bucket": assign_bucket(d, pico.sesoi, pico.effectType)["bucket"],
"n": d.get("n"),
"effect": d.get("estimate"),
"scale": d.get("effect_type"),
"evidenceTier": assign_bucket(d, pico.sesoi, pico.effectType)[
"evidence_tier"
],
"primaryOutcome": d.get("outcome"),
"analysisScale": assign_bucket(d, pico.sesoi, pico.effectType)[
"analysis_effect_type"
],
}
for d in studies[:12]
],
},
usage,
)
summary, drivers = narrative.summary, narrative.drivers
except Exception as exc:
logger.warning("Narration unavailable: %s", type(exc).__name__)
warnings.append(
"AI narration was unavailable; the summary reports computed counts directly."
)
groups = Counter(d.get("population", "").strip() for d in studies if d.get("population"))
alternatives = [
{
"label": population,
"reason": "Sparse representation in retrieved studies; investigate coverage before treating this as an untested population.",
"evidenceCount": count,
}
for population, count in sorted(groups.items(), key=lambda x: x[1])[:3]
]
for term in aggregation["nullTerms"][:3]:
alternatives.append(
{
"label": f"Reconsider outcome/context: {term['term']}",
"reason": "Over-represented in null-result abstracts (credible or reported); inspect the source studies before reusing this design.",
"evidenceCount": term["count"],
}
)
ev = stats.get("expectedValue")
pursuit = stats["pursuit"]
recommended_pico = await self.recommend_pico(
pico, pursuit, studies, verdicts, aggregation, alternatives, usage, warnings
)
return {
"queryId": f"q_{uuid4().hex}",
"idea": request.idea,
"field": request.field,
"keywords": list(
dict.fromkeys(filter(None, [pico.intervention, pico.outcome, *pico.synonyms]))
),
"searchedSources": ["openalex", "clinicaltrials"],
"totalScanned": aggregation["total"],
"papers": [to_paper(d, pico.sesoi, pico.effectType) for d in studies[:50]],
"summary": summary,
"estimate": {
"pSuccess": stats.get("assurance"),
"pPursue": pursuit["pPursue"],
"expectedValue": ev,
"confidence": "low",
"recommendation": pursuit["recommendation"],
"drivers": drivers,
},
"recommendedPico": recommended_pico,
"completedAt": datetime.now(UTC).isoformat(),
"pico": pico.model_dump(),
"bucketCounts": aggregation["bucketCounts"],
"inconclusiveReasons": aggregation.get("inconclusiveReasons"),
# Over the full match set, unlike effectTrend, which covers the studies read.
"effectDirections": aggregation.get("effectDirections"),
"yearCounts": aggregation["yearCounts"],
"countScope": count_scope,
# Null unless a bound was set, so a result can never look filtered when it is not.
"filters": applied_filters,
"screening": screening,
"nullTerms": aggregation["nullTerms"],
"statistics": stats,
"costs": usage.summary([d.get("abstract", "") for d in targets], self.config),
"warnings": list(dict.fromkeys(warnings)),
"alternativeRoutes": alternatives,
"effectTrend": effect_trend,
"overview": overview,
# Read studies with an identified comparison group; without one, nothing here
# tested the question, however many records matched.
"evidenceBase": {"read": len(studies), "controlled": controlled},
"retrieval": {
"mode": mode,
"expanded": len(expanded),
# Echoed so a reordered page can say what reordered it.
"concepts": steer.model_dump() if steer else None,
"durationMs": round((perf_counter() - started) * 1000),
},
"spin": aggregation["spin"],
}
|