docs: complete collections API documentation for remaining metrics #2420
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… API - Added new primary example using collections-based API with ResponseGroundedness - Added synchronous usage note with .score() method - Moved legacy SingleTurnSample example to Legacy Metrics API section - Tested new example and verified it produces expected output (score: 1.0)
- Add primary example using ContextRecall from ragas.metrics.collections - Include synchronous usage note with .score() method - Move LLMContextRecall to legacy section with deprecation warning - Keep NonLLMContextRecall and IDBasedContextRecall as valid alternatives (no collections API equivalents) - Tested example and verified output
dosubot
bot
added
the
size:L
anistark
approved these changes
Nov 12, 2025
anistark
pushed a commit
that referenced
this pull request
Nov 17, 2025
…2420) ## Issue Link / Problem Description - Follow-up to PR #2407 - Completes the migration to collections-based API documentation for metrics that were not covered in the initial PR ## Changes Made - Updated **ContextRecall** documentation to showcase `ragas.metrics.collections.ContextRecall` as the primary example - Updated **FactualCorrectness** documentation to showcase `ragas.metrics.collections.FactualCorrectness` with configuration options (mode, atomicity, coverage) - Updated **ResponseGroundedness** documentation in nvidia_metrics.md to showcase `ragas.metrics.collections.ResponseGroundedness` as the primary example - Moved all legacy API examples to "Legacy Metrics API" sections with deprecation warnings - Added synchronous usage notes (`.score()` method) for all three metrics - Preserved all conceptual explanations and "How It's Calculated" sections ## Testing ### How to Test - [x] Automated tests added/updated: N/A (documentation only) - [x] Manual testing steps: 1. Verified `make build-docs` succeeds without errors ✓ 2. Tested all new code examples to ensure they work as documented 3. Confirmed output values match expected results 4. Verified consistency with PR #2407 documentation style ## References - Related issues: Follow-up to PR #2407 - Documentation: - Updated: `docs/concepts/metrics/available_metrics/context_recall.md` - Updated: `docs/concepts/metrics/available_metrics/factual_correctness.md` - Updated: `docs/concepts/metrics/available_metrics/nvidia_metrics.md` (ResponseGroundedness section) - Pattern reference: PR #2407 (faithfulness.md, context_precision.md, answer_correctness.md) ## Screenshots/Examples (if applicable) All three metrics now follow the consistent pattern: 1. **Primary Example**: Collections-based API (modern, recommended) 2. **Concepts**: Implementation-agnostic explanation 3. **Synchronous Usage Note**: `.score()` method alternative 4. **Legacy Section**: Original API with deprecation timeline warnings
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue Link / Problem Description
Changes Made
ragas.metrics.collections.ContextRecallas the primary exampleragas.metrics.collections.FactualCorrectnesswith configuration options (mode, atomicity, coverage)ragas.metrics.collections.ResponseGroundednessas the primary example.score()method) for all three metricsTesting
How to Test
make build-docssucceeds without errors ✓References
docs/concepts/metrics/available_metrics/context_recall.mddocs/concepts/metrics/available_metrics/factual_correctness.mddocs/concepts/metrics/available_metrics/nvidia_metrics.md(ResponseGroundedness section)Screenshots/Examples (if applicable)
All three metrics now follow the consistent pattern:
.score()method alternativeThank you for reviewing! This PR completes the collections API documentation migration started in PR #2407.