File size: 30,375 Bytes
0721bb4 5a60e93 0e5fdb5 0721bb4 f282b15 49b0848 0721bb4 f282b15 0721bb4 49b0848 0721bb4 49b0848 0721bb4 49b0848 0721bb4 49b0848 0e5fdb5 0721bb4 d65c41d 0721bb4 0e5fdb5 0721bb4 49b0848 0721bb4 49b0848 f282b15 49b0848 f282b15 49b0848 5a60e93 49b0848 0721bb4 b9dfc76 0721bb4 b9dfc76 0721bb4 49b0848 0721bb4 49b0848 0721bb4 0e02a0f 49b0848 0e02a0f 49b0848 0721bb4 49b0848 0721bb4 49b0848 0e5fdb5 0721bb4 0e02a0f 0721bb4 0e02a0f 0e5fdb5 0e02a0f 0e5fdb5 0e02a0f 0721bb4 49b0848 0721bb4 0e5fdb5 49b0848 0e5fdb5 5a60e93 0721bb4 0e5fdb5 0721bb4 0e5fdb5 0721bb4 0e5fdb5 0721bb4 49b0848 0e02a0f 49b0848 0721bb4 0e02a0f 0721bb4 0e02a0f 0721bb4 0e02a0f 0721bb4 0e02a0f 49b0848 0721bb4 f282b15 49b0848 f282b15 0721bb4 49b0848 0721bb4 49b0848 0721bb4 b9dfc76 0721bb4 49b0848 0721bb4 0e02a0f 0721bb4 0e5fdb5 0721bb4 49b0848 0721bb4 49b0848 5a60e93 0721bb4 b9dfc76 0721bb4 b9dfc76 f282b15 b9dfc76 0721bb4 49b0848 0721bb4 49b0848 | 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 | """ReportGenerator β turns a session's AnalysisRecords into an AnalysisReport (KM-644).
A button-triggered service shaped like the Assembler: deterministic assembly of the
records (findings/caveats/open_questions/data_sources/method_steps, copied verbatim β
INV-4) wrapped around exactly ONE LLM call that authors only the executive summary.
If that call fails the report is still returned with a deterministic fallback
summary (decision D1) β the deterministic body is the real value.
Versioning + persistence live in `ReportStore`; this service does generation only
(returns an `AnalysisReport` with `version=0`; the store assigns the real version).
Chain construction mirrors `agents/slow_path/assembler.py`.
"""
from __future__ import annotations
import json
import re
from datetime import UTC, datetime
from pathlib import Path
from langchain_core.messages import SystemMessage
from langchain_core.prompts import ChatPromptTemplate
from langchain_core.runnables import Runnable
from langchain_openai import AzureChatOpenAI
from src.middlewares.logging import get_logger
# Reused, not re-implemented: the traceability preview and the report evidence table
# are the two persisted sinks F-9 masks, and a second copy of the mask marker or the
# index lookup would be the exact drift CODE_REVIEW F-27 warns about.
from src.traceability.scratchpad import _PII_MASK, _pii_indexes
from ..language import detect_reply_language
from ..slow_path.schemas import AnalysisRecord, TaskSummary
from .errors import ReportError
from .readiness import has_reportable_result
from .schemas import (
AnalysisReport,
AttributedNote,
BQAnswerDraft,
BusinessQuestionAnswer,
DataSourceRef,
EvidenceTable,
ProblemStatement,
ReportFinding,
ReportSummaryNarrative,
)
logger = get_logger("report_generator")
_FALLBACK_SUMMARY = "Automated summary unavailable β see the findings below."
# Caps keeping the deterministic sections readable on multi-record analyses.
_MAX_CAVEATS = 12
_MAX_OPEN_QUESTIONS = 10
_EVIDENCE_MAX_ROWS = 10
_EVIDENCE_MAX_TABLES = 3 # per record
# Wider tables are raw analysis *inputs* (e.g. a 19-column correlation pull), not
# presentable evidence β grouped/top-N/merge results are always narrow.
_EVIDENCE_MAX_COLS = 8
# CRISP-DM phases in narrative order, with human labels for the method appendix.
_STAGE_LABELS: list[tuple[str, str]] = [
("data_understanding", "Data understanding"),
("data_preparation", "Data preparation"),
("modeling", "Modeling"),
("evaluation", "Evaluation"),
]
# Human labels for BusinessQuestionAnswer.status in the rendered markdown.
_BQ_STATUS_LABELS: dict[str, str] = {
"answered": "Answered",
"partial": "Partially answered",
"unanswered": "Unanswered",
}
# Friendly labels for the catalog's internal source_type enum, shown in Data Sources.
_SOURCE_TYPE_LABELS: dict[str, str] = {
"schema": "Database",
"tabular": "Tabular file",
"unstructured": "Documents",
}
_PROMPT_PATH = (
Path(__file__).resolve().parent.parent.parent / "config" / "prompts" / "report_summary.md"
)
def _load_prompt_text() -> str:
return _PROMPT_PATH.read_text(encoding="utf-8")
def _build_default_chain() -> Runnable:
from src.config.settings import settings
llm = AzureChatOpenAI(
azure_deployment=settings.azureai_deployment_name_54m,
openai_api_version=settings.azureai_api_version_54m,
azure_endpoint=settings.azureai_endpoint_url_54m,
api_key=settings.azureai_api_key_54m,
temperature=0,
)
prompt = ChatPromptTemplate.from_messages(
[
SystemMessage(content=_load_prompt_text()),
("human", "{human_content}"),
]
)
return prompt | llm.with_structured_output(ReportSummaryNarrative)
_default_chain: Runnable | None = None
def _get_default_chain() -> Runnable:
global _default_chain
if _default_chain is None:
_default_chain = _build_default_chain()
return _default_chain
# --------------------------------------------------------------------------- #
# Deterministic assembly (pure; no LLM, no I/O) β easy to unit-test.
# --------------------------------------------------------------------------- #
def _collect_findings(records: list[AnalysisRecord]) -> list[ReportFinding]:
# Each finding traces to its record. Deduped *within* a record (an Assembler run
# occasionally repeats a line); kept across records so the grouped render can show
# each analysis's own findings under its own question.
out: list[ReportFinding] = []
for rec in records:
seen: set[str] = set()
for text in rec.findings:
if text in seen:
continue
seen.add(text)
out.append(ReportFinding(text=text, record_ids=[rec.record_id]))
return out
def _note_key(text: str) -> str:
# Dedupe key: collapse whitespace, drop trailing punctuation, casefold β so the
# Assembler's near-identical rephrasings ("Data is capped at 500 rows." vs
# "data is capped at 500 rows") merge into one note.
return " ".join(text.split()).rstrip(".!").casefold()
def _collect_notes(records: list[AnalysisRecord], field: str, cap: int) -> list[AttributedNote]:
# Caveats / open_questions are deduped by normalized text; a merged note keeps
# the first phrasing seen and cites every record it came from (plural
# record_ids). Capped so a many-record analysis stays readable.
merged: dict[str, AttributedNote] = {}
for rec in records:
for text in getattr(rec, field):
key = _note_key(text)
if not key:
continue
note = merged.setdefault(key, AttributedNote(text=text))
if rec.record_id not in note.record_ids:
note.record_ids.append(rec.record_id)
return list(merged.values())[:cap]
def _fmt_cell(value) -> str:
if value is None:
return "β"
if isinstance(value, float):
return f"{value:g}" # 1234.5 not 1234.5000000001; no trailing zeros
return str(value)
def _collect_evidence(records: list[AnalysisRecord]) -> dict[str, list[EvidenceTable]]:
"""Copy small result tables out of each record's `results_snapshot` (INV-4).
Table-kind tool outputs only β the copy-paste-able slices (top-N rankings,
grouped aggregates, merges). `check_*` outputs are skipped (catalog metadata,
not evidence). Rows and tables-per-record are capped so a wide retrieval
can't balloon the report.
"""
out: dict[str, list[EvidenceTable]] = {}
for rec in records:
tables: list[EvidenceTable] = []
for result in rec.results_snapshot.values():
for output in result.outputs:
if len(tables) >= _EVIDENCE_MAX_TABLES:
break
if output.tool in ("check_data", "check_knowledge"):
continue
if output.kind != "table" or not output.columns or not output.rows:
continue
if len(output.columns) > _EVIDENCE_MAX_COLS:
continue
# Mask PII cells before they are frozen into `reports.content`
# (F-9, 2026-07-24). A report is a permanent, versioned artifact, so
# this is the sink where an unmasked customer name or email lasts
# longest. The assembler's FINDINGS are untouched β the lead's
# 2026-07-23 decision keeps real values in the answer prose; this
# redacts only the raw evidence dump beneath it. `pii_columns` is
# absent on records persisted before F-9, which yields no masking.
pii_idx = _pii_indexes(
(output.meta or {}).get("pii_columns"), output.columns
)
tables.append(
EvidenceTable(
title=result.objective,
columns=[str(c) for c in output.columns],
rows=[
[
_PII_MASK if i in pii_idx else _fmt_cell(v)
for i, v in enumerate(row)
]
for row in output.rows[:_EVIDENCE_MAX_ROWS]
],
truncated=len(output.rows) > _EVIDENCE_MAX_ROWS,
)
)
if tables:
out[rec.record_id] = tables
return out
_CHARTS_MAX_PER_RECORD = 3 # mirrors _EVIDENCE_MAX_TABLES
def _collect_charts(records: list[AnalysisRecord]) -> dict[str, list[dict]]:
"""Copy chart envelopes out of each record's `results_snapshot` (INV-4).
`render_chart` outputs only β the full `dataeyond.chart.v1` envelope, verbatim
(the snapshot trimmer never touches chart-kind outputs, so the spec is whole).
Rendered as ```plotly fenced blocks in the markdown EDA section.
"""
out: dict[str, list[dict]] = {}
for rec in records:
charts: list[dict] = []
for result in rec.results_snapshot.values():
for output in result.outputs:
if len(charts) >= _CHARTS_MAX_PER_RECORD:
break
if output.kind != "chart" or not isinstance(output.value, dict):
continue
if not isinstance(output.value.get("plotly"), dict):
continue
charts.append(output.value)
if charts:
out[rec.record_id] = charts
return out
def _unresolved_note(rec: AnalysisRecord) -> AttributedNote:
# Goal + the record's own first caveat as the "why" β both Assembler-authored,
# nothing new is synthesized here.
text = rec.goal_restated or "Analysis run"
reason = next(iter(rec.caveats), None)
if reason:
text += f" β {reason}"
return AttributedNote(text=text, record_ids=[rec.record_id])
def _excluded_note(rec: AnalysisRecord) -> AttributedNote:
return AttributedNote(
text=rec.goal_restated or rec.record_id, record_ids=[rec.record_id]
)
def _collect_method_steps(records: list[AnalysisRecord]) -> list[TaskSummary]:
steps: list[TaskSummary] = []
for rec in records:
steps.extend(rec.tasks_run)
return steps
def _build_data_sources(
records: list[AnalysisRecord], catalog
) -> list[DataSourceRef]:
"""Freeze real catalog metadata for the sources this analysis used.
`catalog` is the analysis-scope catalog β already restricted to this analysis's
bound sources β so every source in it is a candidate. Matches candidates against
the records' (narrative) `data_used` by name/id; falls back to all sources, then
to bare `data_used` strings if no catalog is available β so the section is always
populated, best-effort.
"""
if catalog is None or not catalog.sources:
seen: list[str] = []
for rec in records:
for du in rec.data_used:
if du not in seen:
seen.append(du)
return [DataSourceRef(source_id=d, name=d, source_type="", detail={}) for d in seen]
candidates = catalog.sources
def _ref(s) -> DataSourceRef:
return DataSourceRef(
source_id=s.source_id,
name=s.name,
source_type=s.source_type,
detail={
"tables": [t.name for t in s.tables],
"row_count": sum((t.row_count or 0) for t in s.tables) or None,
"columns": [c.name for t in s.tables for c in t.columns],
},
)
used = " ".join(du for rec in records for du in rec.data_used).lower()
matched = [
_ref(s)
for s in candidates
if s.name.lower() in used or s.source_id.lower() in used
]
return matched or [_ref(s) for s in candidates]
def _build_human_content(
ps: ProblemStatement,
records: list[AnalysisRecord],
caveats: list[AttributedNote],
reply_language: str,
) -> str:
# Questions and analyses are NUMBERED so the model can reference them by index
# in `bq_answers` (question_index / analysis_indexes) β it never reproduces ids.
sections = []
if ps.objective:
sections.append("# Objective\n" + ps.objective)
if ps.business_questions:
sections.append(
"# Business questions\n"
+ "\n".join(f"{i}. {q}" for i, q in enumerate(ps.business_questions, 1))
)
lines = ["# Analyses (findings already finalized β synthesize, do not add numbers)"]
for i, rec in enumerate(records, 1):
lines.append(f"Analysis {i}: {rec.goal_restated}")
seen: set[str] = set()
for text in rec.findings:
if text in seen:
continue
seen.add(text)
lines.append(f"- {text}")
sections.append("\n".join(lines))
if caveats:
sections.append("# Caveats\n" + "\n".join(f"- {c.text}" for c in caveats))
sections.append("# Reply language\n" + reply_language)
return "\n\n".join(sections)
def _resolve_bq_answers(
drafts: list[BQAnswerDraft],
questions: list[str],
records: list[AnalysisRecord],
) -> list[BusinessQuestionAnswer]:
"""Map the LLM's index-based drafts onto real question text and record ids.
Every question gets a row (unanswered when the model skipped it);
out-of-range indexes are silently dropped.
"""
if not questions:
return []
by_index = {d.question_index: d for d in drafts}
out: list[BusinessQuestionAnswer] = []
for i, question in enumerate(questions, 1):
draft = by_index.get(i)
if draft is None:
out.append(BusinessQuestionAnswer(question=question))
continue
record_ids = [
records[j - 1].record_id
for j in draft.analysis_indexes
if 1 <= j <= len(records)
]
out.append(
BusinessQuestionAnswer(
question=question,
answer=draft.answer,
status=draft.status,
record_ids=record_ids,
)
)
return out
# Inline code spans (one or more backticks). Content inside is already literal in
# Markdown/MDX, so escaping within them would only surface a visible backslash
# (e.g. `product\_id`). We keep code spans verbatim and escape only around them.
_CODE_SPAN_RE = re.compile(r"`+[^`]*`+")
def _mdx_escape(text: str) -> str:
"""Escape Markdown/MDX syntax characters in a dynamic value.
Applied only to values authored outside the renderer (LLM findings/caveats,
user objective/questions, catalog source & table names, tool names) so that
identifiers like ``XL_S_129`` don't italicize and stray ``<``/``{`` don't break
MDX compilation. Content inside inline code spans is left verbatim (already
literal). NOT applied to the executive summary (its prompt allows light inline
emphasis) nor to the structural markdown the renderer emits itself.
"""
if not text:
return text
def _esc(s: str) -> str:
s = s.replace("\\", "\\\\")
for ch in ("<", "{", "|", "_", "*"):
s = s.replace(ch, "\\" + ch)
return s
out: list[str] = []
pos = 0
for m in _CODE_SPAN_RE.finditer(text):
out.append(_esc(text[pos : m.start()]))
out.append(m.group(0)) # keep the code span verbatim
pos = m.end()
out.append(_esc(text[pos:]))
return "".join(out)
def _render_markdown(report: AnalysisReport) -> str:
# Version is deliberately NOT in the markdown β it is assigned by the store
# after rendering and lives in the structured `version` field / API metadata.
meta = f"*Generated {report.generated_at:%Y-%m-%d}"
author = report.user_name or report.user_id
if author:
meta += f" by {author}"
meta += f" Β· {len(report.record_ids)} analyses Β· {len(report.data_sources)} source(s)*"
# Title + meta form the header block; each subsequent section is divided by a
# horizontal rule (`---`) so the report reads as a formal, sectioned document.
parts: list[str] = ["# Analysis Report\n" + meta]
ps = report.problem_statement
if ps.objective:
parts.append("## Objective\n" + _mdx_escape(ps.objective))
if ps.business_questions:
parts.append(
"## Business Questions\n"
+ "\n".join(
f"{i}. {_mdx_escape(q)}" for i, q in enumerate(ps.business_questions, 1)
)
)
if report.executive_summary:
parts.append("## Executive Summary\n" + report.executive_summary)
if report.bq_answers:
lines = ["## Answers to Business Questions"]
for i, a in enumerate(report.bq_answers, 1):
label = _BQ_STATUS_LABELS.get(a.status, a.status)
entry = f"{i}. **{_mdx_escape(a.question)}** β *{label}*"
if a.answer:
# LLM prose (same authorship as the executive summary): not escaped.
entry += f"\n {a.answer}"
lines.append(entry)
parts.append("\n".join(lines))
if report.findings:
# Group findings by their originating analysis (record) so results from
# different questions read as separate analyses, not one flat, seemingly
# contradictory list. Subheadings (the restated question) appear only when
# more than one analysis contributed.
by_record: dict[str, list[ReportFinding]] = {}
for f in report.findings:
by_record.setdefault(f.record_ids[0] if f.record_ids else "", []).append(f)
ordered = [rid for rid in report.record_goals if rid in by_record]
ordered += [rid for rid in by_record if rid not in ordered]
grouped = sum(1 for rid in ordered if by_record.get(rid)) > 1
blocks = ["## Key Findings"]
for rid in ordered:
group = by_record.get(rid)
if not group:
continue
block: list[str] = []
if grouped:
block.append(f"### {_mdx_escape(report.record_goals.get(rid) or 'Analysis')}")
block.extend(f"{i}. {_mdx_escape(f.text)}" for i, f in enumerate(group, 1))
# Evidence tables (copied result slices) under the findings they back,
# so the numbers are copy-paste-ready next to the claims.
for tbl in report.evidence_tables.get(rid, []):
if not tbl.columns:
continue
block.append("") # blank line: terminate the list before the table
if tbl.title:
block.append(f"**{_mdx_escape(tbl.title)}**")
block.append("")
block.append("| " + " | ".join(_mdx_escape(c) for c in tbl.columns) + " |")
block.append("|" + "---|" * len(tbl.columns))
block.extend(
"| " + " | ".join(_mdx_escape(c) for c in row) + " |"
for row in tbl.rows
)
if tbl.truncated:
block.append(f"\n*(first {len(tbl.rows)} rows shown)*")
blocks.append("\n".join(block))
parts.append("\n\n".join(blocks))
# ## EDA β charts (W2, 2026-07-14). Each chart a `render_chart` task produced
# is emitted as a ```plotly fenced block the FE's fence hook renders with
# plotly.js. Fence content is the FULL dataeyond.chart.v1 envelope, verbatim
# (INV-4) and pretty-printed β the shape the FE hook parses (verified against
# the FE 2026-07-14; it reads spec.plotly internally). Section omitted when no
# record produced a chart.
if report.charts:
lines = ["## EDA"]
ordered_rids = [rid for rid in report.record_ids if rid in report.charts]
ordered_rids += [rid for rid in report.charts if rid not in ordered_rids]
for rid in ordered_rids:
for envelope in report.charts[rid]:
caption = envelope.get("title") or report.record_goals.get(rid) or "Chart"
lines.append(f"**{_mdx_escape(str(caption))}**")
lines.append("")
lines.append("```plotly")
lines.append(json.dumps(envelope, ensure_ascii=False, indent=2))
lines.append("```")
lines.append("")
parts.append("\n".join(lines).rstrip())
if report.data_sources:
lines = ["## Data Sources", "| source | type | detail |", "|---|---|---|"]
for ds in report.data_sources:
d = ds.detail
bits = []
if d.get("tables"):
bits.append("tables: " + ", ".join(_mdx_escape(t) for t in d["tables"]))
if d.get("columns"):
bits.append(f"{len(d['columns'])} columns")
type_label = _SOURCE_TYPE_LABELS.get(ds.source_type, ds.source_type or "β")
lines.append(
f"| {_mdx_escape(ds.name)} | {type_label} | {' Β· '.join(bits) or 'β'} |"
)
parts.append("\n".join(lines))
# ## Notes & Limitations β dropped from the rendered report 2026-07-09 (team
# decision: compact report). caveats/open_questions still populate the
# AnalysisReport JSON body; only the markdown section is gone.
# if report.caveats or report.open_questions:
# lines = ["## Notes & Limitations"]
# for n in report.caveats:
# lines.append(f"- {_mdx_escape(n.text)}")
# for n in report.open_questions:
# lines.append(f"- Open: {_mdx_escape(n.text)}")
# parts.append("\n".join(lines))
# ## Attempted, Unresolved β dropped from the rendered report 2026-07-09 (team
# decision: compact report). Failed runs still populate `report.unresolved`
# (JSON body) and the /records curation list; only the markdown section is gone.
# if report.unresolved:
# lines = [
# "## Attempted, Unresolved",
# "*These analyses ran but produced no usable evidence;"
# " they are not reflected in the findings above.*",
# "",
# ]
# lines.extend(f"- {_mdx_escape(n.text)}" for n in report.unresolved)
# parts.append("\n".join(lines))
if report.excluded:
lines = [
"## Excluded Analyses",
"*Excluded from this report at generation time.*",
"",
]
lines.extend(f"- {_mdx_escape(n.text)}" for n in report.excluded)
parts.append("\n".join(lines))
# ## How This Was Analyzed β dropped from the rendered report 2026-07-09 (team
# decision: compact report). method_steps (and _STAGE_LABELS above) stay for the
# AnalysisReport JSON body; only the markdown section is gone.
# if report.method_steps:
# lines = ["## How This Was Analyzed"]
# for stage_key, label in _STAGE_LABELS:
# steps = [s for s in report.method_steps if s.stage == stage_key]
# if not steps:
# continue
# rendered = "; ".join(
# f"{', '.join(_mdx_escape(t) for t in s.tools_used) or 'β'} ({s.status})"
# for s in steps
# )
# lines.append(f"**{label}** β {rendered}")
# parts.append("\n".join(lines))
return "\n\n---\n\n".join(parts)
# --------------------------------------------------------------------------- #
# Service
# --------------------------------------------------------------------------- #
class ReportGenerator:
"""Generates an `AnalysisReport` from persisted records. Inject deps for tests."""
def __init__(
self,
record_store=None,
structured_chain: Runnable | None = None,
catalog_store=None,
) -> None:
self._record_store = record_store
self._chain = structured_chain
self._catalog_store = catalog_store
def _ensure_record_store(self):
if self._record_store is None:
from ..slow_path.store import PostgresReportInputStore
self._record_store = PostgresReportInputStore()
return self._record_store
def _ensure_chain(self) -> Runnable:
if self._chain is None:
self._chain = _get_default_chain()
return self._chain
def _ensure_catalog_store(self):
if self._catalog_store is None:
from src.catalog.store import CatalogStore
self._catalog_store = CatalogStore()
return self._catalog_store
async def generate(
self,
analysis_id: str,
user_id: str | None = None,
problem_statement: ProblemStatement | None = None,
user_name: str | None = None,
exclude_record_ids: list[str] | None = None,
) -> AnalysisReport:
# Scoped to the requesting user (2026-07-23): `POST /tools/report` always
# supplies `user_id`, so a report can only ever be built from records the
# caller owns.
all_records = await self._ensure_record_store().list_for_analysis(
analysis_id, user_id
)
excluded_ids = set(exclude_record_ids or [])
excluded = [r for r in all_records if r.record_id in excluded_ids]
kept = [r for r in all_records if r.record_id not in excluded_ids]
# The report body reflects every run that produced work worth showing β
# `has_reportable_result`, NOT the floor's `has_successful_analysis`. The two
# were the same predicate until planner recipes R2/R2b made the `analyze_*`
# step optional: a grouped/scalar aggregate answered entirely inside one
# `retrieve_data` IR is a complete analysis with no analyze_* tool, and the
# floor's predicate dropped those runs from the body, so their business
# question rendered "Unanswered". Runs whose analysis step actually FAILED
# are still excluded here (they can't contradict the real findings) and still
# surface in the JSON `unresolved` list and the /records curation endpoint
# (the rendered markdown section was dropped 2026-07-09).
records = [r for r in kept if has_reportable_result(r)]
unresolved_records = [r for r in kept if not has_reportable_result(r)]
if unresolved_records:
# The dropped-runs path was previously silent, which is why a correct
# answer showing up as "Unanswered" took a bug report to find.
logger.info(
"report: runs excluded from body",
analysis_id=analysis_id,
excluded=[r.record_id for r in unresolved_records],
)
if not records:
raise ReportError(f"no analyses recorded for {analysis_id!r} yet")
ps = problem_statement or ProblemStatement()
reply_language = detect_reply_language(
None, goal_texts=[ps.objective, *ps.business_questions]
)
findings = _collect_findings(records)
caveats = _collect_notes(records, "caveats", _MAX_CAVEATS)
open_questions = _collect_notes(records, "open_questions", _MAX_OPEN_QUESTIONS)
method_steps = _collect_method_steps(records)
data_sources = _build_data_sources(
records, await self._read_catalog(user_id, analysis_id)
)
executive_summary, bq_answers = await self._summarize(
ps, records, caveats, reply_language
)
report = AnalysisReport(
analysis_id=analysis_id,
user_id=user_id,
user_name=user_name,
version=0, # assigned by ReportStore.save under the advisory lock
generated_at=datetime.now(UTC),
problem_statement=ps,
record_ids=[r.record_id for r in records],
record_goals={r.record_id: r.goal_restated for r in records},
executive_summary=executive_summary,
bq_answers=bq_answers,
findings=findings,
caveats=caveats,
open_questions=open_questions,
unresolved=[_unresolved_note(r) for r in unresolved_records],
excluded=[_excluded_note(r) for r in excluded],
evidence_tables=_collect_evidence(records),
charts=_collect_charts(records),
data_sources=data_sources,
method_steps=method_steps,
)
report.rendered_markdown = _render_markdown(report)
logger.info(
"report generated",
analysis_id=analysis_id,
records=len(records),
findings=len(findings),
)
return report
async def _read_catalog(self, user_id: str | None, analysis_id: str | None):
"""Prefer the analysis-scope catalog (this analysis's bound sources + their
real names); fall back to the user-scope catalog when the analysis has no row
(legacy / unbound)."""
try:
store = self._ensure_catalog_store()
if analysis_id:
# Scoped to the requesting user (2026-07-23) β see CatalogStore.
cat = await store.get_by_analysis(analysis_id, user_id)
if cat is not None:
return cat
return await store.get(user_id) if user_id else None
except Exception as exc: # data_sources falls back; never break the report
logger.warning("catalog read failed; data_sources will fall back", error=str(exc))
return None
async def _summarize(
self,
ps: ProblemStatement,
records: list[AnalysisRecord],
caveats: list[AttributedNote],
reply_language: str,
) -> tuple[str, list[BusinessQuestionAnswer]]:
human_content = _build_human_content(ps, records, caveats, reply_language)
try:
narrative: ReportSummaryNarrative = await self._ensure_chain().ainvoke(
{"human_content": human_content}
)
except Exception as exc: # D1: degrade, don't fail the whole report
logger.warning("report summary LLM failed; using fallback", error=repr(exc))
return _FALLBACK_SUMMARY, []
return narrative.executive_summary, _resolve_bq_answers(
narrative.bq_answers, ps.business_questions, records
)
|