Feat: Add Summary Engine Base Class

[felixjordandev]

This PR introduces the foundational SummaryEngine base class, preparing the system for advanced report summarization.

Changes

• Created a new directory app/services/summary/ to house summarization logic.
• Implemented summary_engine.py with the SummaryEngine base class.
• Defined abstract methods generate_scores(data) and build_final_summary(nlg_outputs, scores).
• Included placeholders for future integration of risk factors and agent confidence levels within the summary generation process.

Summary by CodeRabbit

• Refactor
  • Enhanced internal summary generation infrastructure with improved abstraction layer for better code organization and maintainability.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Introduces a new abstract base class SummaryEngine defining two abstract methods: generate_scores() for computing float scores from input data, and build_final_summary() for constructing final summaries from NLG outputs and scores. The class serves as a template for concrete summary generation implementations.

Changes

Cohort / File(s)	Change Summary
New abstract base class backend/app/services/summary/summary_engine.py	Introduces SummaryEngine abstract base class with two abstract methods: generate_scores(data) returning Dict[str, float] and build_final_summary(nlg_outputs, scores) returning str. Includes docstrings for both methods.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Single new file with minimal complexity (abstract base class definition)
• Two straightforward abstract method signatures with clear type hints
• No logic implementation, no complex control flow
• No cross-file dependencies introduced

Poem

🐰 A base for summaries, abstract and true,
With scores to compute and finals to brew,
Two methods await their concrete form,
A template so clean, a well-structured norm,
Let future implementations bloom! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately captures the main change: introducing a new abstract base class SummaryEngine for report summarization functionality.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/add-summary-engine

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

backend/app/services/summary/summary_engine.py (2)

8-27: Good abstraction; consider tightening input typing for future extensibility

The base class shape and docstring are clear and give a good extension point. Given you already anticipate “risk factors” and “agent confidence levels,” you might soon outgrow data: Dict[str, Any]. Consider introducing a typed structure (e.g., a TypedDict or dataclass that the engine consumes) so concrete implementations share a stable contract instead of relying on ad‑hoc dict keys.

---

28-40: Clarify expectations around key alignment and error handling in build_final_summary

The method signature looks good, but the docstring doesn’t say what happens if nlg_outputs and scores have mismatched or missing keys, or whether implementations should assume alignment. Adding a brief note about expected invariants (e.g., keys must match; implementations should handle missing entries gracefully) will make subclass behavior more consistent.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c404c7d and 293f693.

📒 Files selected for processing (1)

• backend/app/services/summary/summary_engine.py (1 hunks)

[klingonaston]

The abstract methods in SummaryEngine are a solid starting point for the summarization logic. Merging this in now.