Require tool
require_tool ¶
Scorer wrapper that requires a named tool to appear in the trajectory.
This module provides RequireToolScorer, which wraps another Scorer and scores 0.0 unless the agent called a named tool during the row's run. It declares the optional trajectory parameter, so the evolution adapters send it the row's ADKTrajectory on every evaluation.
| ATTRIBUTE | DESCRIPTION |
|---|---|
RequireToolScorer | Scores 0.0 when the required tool did not run, otherwise delegates to the wrapped scorer. TYPE: |
Examples:
Require a lookup tool before a label counts:
from gepa_adk.adapters.scoring import LabelAgreementScorer, RequireToolScorer
scorer = RequireToolScorer(LabelAgreementScorer(field="label"), tool="ask_x")
See Also
gepa_adk.ports.scorer: Protocol that RequireToolScorer implements, andscorer_accepts_trajectory.gepa_adk.adapters.scoring.label_agreement: Deterministic scorer commonly wrapped by RequireToolScorer.
Notes
The tool check compares ToolCallRecord.name with the required name exactly. A row scored without a trajectory scores 0.0 with metadata["reason"] == "trajectory_unavailable". The inner scorer's score and async_score are inspected separately, and each receives trajectory= only when it declares that parameter by keyword.
RequireToolScorer ¶
Scorer that gates an inner scorer on a required tool call.
| ATTRIBUTE | DESCRIPTION |
|---|---|
inner | Wrapped scorer consulted when the tool ran. TYPE: |
tool | Name of the tool that must appear in the trajectory. TYPE: |
Examples:
from gepa_adk import LabelAgreementScorer, RequireToolScorer, evolve
scorer = RequireToolScorer(LabelAgreementScorer(field="label"), tool="ask_x")
result = await evolve(agent, trainset, scorer=scorer)
Notes
Adheres to the Scorer protocol. Metadata always carries required_tool and tool_called. The score is 0.0 with metadata["reason"] set to "trajectory_unavailable" when no trajectory was given and "tool_not_called" when the tool is absent. Otherwise the inner scorer's score and metadata are returned.
Source code in src/gepa_adk/adapters/scoring/require_tool.py
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 | |
__init__ ¶
__init__(inner: Scorer, tool: str) -> None
Store the wrapped scorer and the required tool name.
| PARAMETER | DESCRIPTION |
|---|---|
inner | Scorer to delegate to when the tool ran. TYPE: |
tool | Name of the tool that must appear in the trajectory. TYPE: |
| RAISES | DESCRIPTION |
|---|---|
ValueError | If |
TypeError | If |
Notes
Records separately whether inner.score and inner.async_score accept trajectory by keyword.
Source code in src/gepa_adk/adapters/scoring/require_tool.py
score ¶
score(
input_text: str,
output: str,
expected: str | None = None,
*,
trajectory: ADKTrajectory | None = None,
) -> tuple[float, dict[str, Any]]
Score synchronously, requiring the tool before delegating.
| PARAMETER | DESCRIPTION |
|---|---|
input_text | Input given to the agent. TYPE: |
output | Agent output text. TYPE: |
expected | Label from the trainset row, if any. TYPE: |
trajectory | Row trajectory from the adapter, if available. TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
float |
|
dict[str, Any] | scorer's result with the tool metadata added. |
Notes
Forwards trajectory only when the corresponding inner method declares it.
Source code in src/gepa_adk/adapters/scoring/require_tool.py
async_score async ¶
async_score(
input_text: str,
output: str,
expected: str | None = None,
*,
trajectory: ADKTrajectory | None = None,
) -> tuple[float, dict[str, Any]]
Score asynchronously, requiring the tool before delegating.
| PARAMETER | DESCRIPTION |
|---|---|
input_text | Input given to the agent. TYPE: |
output | Agent output text. TYPE: |
expected | Label from the trainset row, if any. TYPE: |
trajectory | Row trajectory from the adapter, if available. TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
float |
|
dict[str, Any] | scorer's result with the tool metadata added. |
Notes
Forwards trajectory only when the corresponding inner method declares it.