docs(evaluate): document rubric_based_multi_turn_trajectory_quality_v1 and clarify Rubric.type / criterion.rubrics#1853
Draft
zettaittenani wants to merge 1 commit into
Conversation
…1 and clarify Rubric.type / criterion.rubrics Closes three gaps in docs/evaluate/criteria.md: 1. Adds a section for `rubric_based_multi_turn_trajectory_quality_v1`. The metric is registered in metric_evaluator_registry.py and implemented in rubric_based_multi_turn_trajectory_evaluator.py upstream, but the explanatory section that its two sibling rubric-based metrics have was missing. Also adds the corresponding row to the criteria table. 2. Adds a "Notes On Rubrics" subsection under each of the three rubric-based metric sections, stating the required Rubric.type value (FINAL_RESPONSE_QUALITY / TOOL_USE_QUALITY / TRAJECTORY_QUALITY) and the criterion-vs-EvalCase rubric relationship (criterion.rubrics required and non-empty; EvalCase.rubrics is additive, filtered by type). 3. Adds the explicit `type` field to existing JSON examples in the two existing rubric-based sections so users have a complete template. Refs google#1852.
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #1852.
What
Closes a documentation gap around rubric-based evaluation criteria in
docs/evaluate/criteria.md. Three small additions:rubric_based_multi_turn_trajectory_quality_v1. The metric is registered inmetric_evaluator_registry.pyand exists in upstream ADK 2.x, but the explanatory section that the other two rubric-based metrics have was missing. Also adds the corresponding row to the criteria table at the top of the page.Rubric.typenotes added to each rubric-based metric section. EachRubricBasedEvaluatorsubclass uses aRUBRIC_TYPEClassVar that acts as a filter — rubrics carried onEvalCase.rubricsare only picked up when theirtypefield matches the evaluator's expected value:Rubric.typerubric_based_final_response_quality_v1FINAL_RESPONSE_QUALITYrubric_based_tool_use_quality_v1TOOL_USE_QUALITYrubric_based_multi_turn_trajectory_quality_v1TRAJECTORY_QUALITYtypefield explicitly so users have a complete template.criterion.rubricsrequirement clarified.RubricBasedEvaluator.__init__assertscriterion.rubricsis non-empty (rubric_based_evaluator.py:332), andEvalCase.rubricsis additive on top of the criterion-level list (create_effective_rubrics_list). The "Notes On Rubrics" block in each rubric-based metric section now states both.Why
Without these notes, three failure modes happen quickly in practice (see #1852 for full context):
rubric_based_multi_turn_trajectory_quality_v1in the criteria table but no example of how to build anEvalConfigentry for it.EvalCase.rubricswithtypeunset (or mismatched) and the rubrics are silently dropped.EvalCase.rubricsand none on the criterion, and hitAssertionError: Rubrics are required.at evaluator init.All three are observable in
RubricBasedEvaluatorsource but aren't surfaced in the user-facing docs.Changes
Only
docs/evaluate/criteria.mdis modified. No code changes.Testing
mkdocs servelocally; verified the new section renders, the criteria table at the top is consistent with the sections below, and existing internal anchors still resolve.CLA
Individual CLA signed;
cla/googlecheck is passing on this PR.Notes