Core API
api ¶
Public API functions for gepa-adk evolution engine.
This module provides high-level async functions for evolving agent instructions using the GEPA (Generalized Evolutionary Prompt-programming Architecture) approach. Pre-flight validation runs synchronously before any LLM calls to give developers immediate feedback on invalid configurations. Each entry point has a dedicated pre-flight validator (_pre_flight_validate_evolve, _pre_flight_validate_group, _pre_flight_validate_workflow). Each entry point accepts either a critic agent or a caller-supplied scorer (mutually exclusive); an explicit scorer takes precedence over schema-based scoring. When evolve() falls back to SchemaBasedScorer over trainset rows that carry expected, it logs a warning that points to LabelAgreementScorer via scorer=. The default reflection agent takes EvolutionConfig.reflection_model as either a model string or a BaseLlm instance, which is passed through unchanged so a custom api_base or temperature reaches the reflector. evolve() seeds any component other than instruction and output_schema from its handler in the component handler registry passed as registry (the default registry when omitted), so names added by register_handler() or register_mapping_components() can be evolved. evolve(), evolve_group() and evolve_workflow() resolve every component name through that one registry and raise ConfigurationError naming a component it does not hold. evolve() returns the engine's EvolutionResult via dataclasses.replace, so its failure counters, stop reason and token usage reach the caller. Its ADKAdapter limits concurrent evaluation rows to the configured max_concurrent_evals; group evolution does not apply this setting.
Notes
The public API exposes evolve(), evolve_group(), evolve_workflow(), and run_sync() as primary entry points. All async functions should be awaited. For synchronous usage in scripts, use run_sync(evolve(...)) which handles event loop management internally; inside a running loop it needs the optional nest_asyncio package. evolve_sync() is deprecated in favor of run_sync() and emits a DeprecationWarning. For reproducible evolution, pass a seeded config: config=EvolutionConfig(seed=42).
Examples:
Single-agent evolution (synchronous):
from google.adk.agents import LlmAgent
from google.adk.models.lite_llm import LiteLlm
from gepa_adk.api import evolve, run_sync
agent = LlmAgent(
name="helper",
model=LiteLlm(model="ollama_chat/gpt-oss:20b"),
instruction="Be helpful.",
)
result = run_sync(evolve(agent, trainset=[{"input": "hi"}]))
Workflow evolution across a multi-agent graph:
from gepa_adk.api import evolve_workflow
result = await evolve_workflow(workflow_root, trainset=trainset)
See Also
gepa_adk.engine: Core evolution engine and mutation proposers. gepa_adk.ports: Protocol definitions consumed by this module. gepa_adk.domain.models: Candidate, EvolutionConfig, and EvolutionResult.
SchemaBasedScorer ¶
Scorer that extracts scores from agent's structured output_schema.
When an agent has an output_schema, its output is structured JSON. This scorer parses that JSON and extracts a "score" field.
| ATTRIBUTE | DESCRIPTION |
|---|---|
output_schema | The Pydantic BaseModel schema class from agent.output_schema. Must contain a "score" field. TYPE: |
Examples:
Basic usage:
from pydantic import BaseModel, Field
from google.adk.agents import LlmAgent
from google.adk.models.lite_llm import LiteLlm
from gepa_adk.api import SchemaBasedScorer
class OutputSchema(BaseModel):
score: float = Field(ge=0.0, le=1.0)
result: str
agent = LlmAgent(
name="agent",
model=LiteLlm(model="ollama_chat/gpt-oss:20b"),
output_schema=OutputSchema,
)
scorer = SchemaBasedScorer(output_schema=OutputSchema)
score, metadata = await scorer.async_score(
input_text="test",
output='{"score": 0.8, "result": "good"}',
)
Notes
Adheres to Scorer protocol. Requires output_schema to have a "score" field. If score field is missing, raises MissingScoreFieldError. The expected argument is never read: the score is the agent's self-reported score field. For a labelled trainset, pass LabelAgreementScorer through the scorer= keyword instead.
Source code in src/gepa_adk/api.py
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 | |
__init__ ¶
Initialize schema-based scorer.
| PARAMETER | DESCRIPTION |
|---|---|
output_schema | Pydantic BaseModel class from agent.output_schema. TYPE: |
| RAISES | DESCRIPTION |
|---|---|
ConfigurationError | If output_schema doesn't have a "score" field. |
Notes
Checks that the schema contains a "score" field during initialization.
Source code in src/gepa_adk/api.py
score ¶
Score an agent output synchronously.
| PARAMETER | DESCRIPTION |
|---|---|
input_text | The input provided to the agent. TYPE: |
output | The agent's structured JSON output. TYPE: |
expected | Optional expected output (not used for schema-based scoring). TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
float | Tuple of (score, metadata) where score is extracted from output JSON |
dict[str, Any] | and metadata contains all other fields from the schema. |
| RAISES | DESCRIPTION |
|---|---|
OutputParseError | If output cannot be parsed as JSON. |
SchemaValidationError | If output doesn't match the schema. |
MissingScoreFieldError | If score field is null in parsed output. |
Examples:
Basic scoring with JSON output:
scorer = SchemaBasedScorer(output_schema=MySchema)
score, metadata = scorer.score(
input_text="What is 2+2?",
output='{"score": 0.9, "result": "4"}',
)
# score == 0.9, metadata == {"result": "4"}
Notes
Operates synchronously by parsing JSON and extracting the score field. The expected parameter is ignored for schema-based scoring.
Source code in src/gepa_adk/api.py
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 | |
async_score async ¶
async_score(
input_text: str,
output: str,
expected: str | None = None,
) -> tuple[float, dict[str, Any]]
Score an agent output asynchronously.
| PARAMETER | DESCRIPTION |
|---|---|
input_text | The input provided to the agent. TYPE: |
output | The agent's structured JSON output. TYPE: |
expected | Optional expected output (not used for schema-based scoring). TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
float | Tuple of (score, metadata) where score is extracted from output JSON |
dict[str, Any] | and metadata contains all other fields from the schema. |
| RAISES | DESCRIPTION |
|---|---|
OutputParseError | If output cannot be parsed as JSON. |
SchemaValidationError | If output doesn't match the schema. |
MissingScoreFieldError | If score field is null in parsed output. |
Examples:
Async scoring with JSON output:
scorer = SchemaBasedScorer(output_schema=MySchema)
score, metadata = await scorer.async_score(
input_text="What is 2+2?",
output='{"score": 0.9, "result": "4"}',
)
# score == 0.9, metadata == {"result": "4"}
Notes
Operates by delegating to synchronous score() since JSON parsing does not require async I/O operations.
Source code in src/gepa_adk/api.py
evolve_group async ¶
evolve_group(
agents: dict[str, LlmAgent],
primary: str,
trainset: list[dict[str, Any]],
*,
components: dict[str, list[str]] | None = None,
critic: LlmAgent | None = None,
scorer: Scorer | None = None,
share_session: bool = True,
config: EvolutionConfig | None = None,
state_guard: StateGuard | None = None,
component_selector: ComponentSelectorProtocol
| str
| None = None,
reflection_agent: LlmAgent | None = None,
trajectory_config: TrajectoryConfig | None = None,
workflow: SequentialAgent
| LoopAgent
| ParallelAgent
| None = None,
session_service: BaseSessionService | None = None,
app: App | None = None,
runner: Runner | None = None,
registry: ComponentHandlerRegistry | None = None,
) -> MultiAgentEvolutionResult
Evolve multiple agents together with per-agent component configuration.
Optimizes specified components for each agent by targeting the primary agent's output score. When share_session=True, agents execute sequentially with shared session state, enabling later agents to access earlier agents' outputs via template strings.
| PARAMETER | DESCRIPTION |
|---|---|
agents | Named ADK agents to evolve together as dict mapping agent names to LlmAgent instances. Must have at least one agent. TYPE: |
primary | Name of the agent whose output is used for scoring. Must match one of the agent names in the dict. TYPE: |
trainset | Training examples for evaluation. Each example should have an "input" key and optionally an "expected" key. TYPE: |
| PARAMETER | DESCRIPTION |
|---|---|
components | Per-agent component configuration mapping agent names to lists of component names to evolve. If None, defaults to evolving "instruction" for all agents. Use empty list to exclude an agent from evolution. Available component names: "instruction", "output_schema", "generate_content_config". TYPE: |
critic | Optional critic agent for scoring. If None and no scorer is given, the primary agent must have an output_schema for schema-based scoring. Mutually exclusive with scorer. TYPE: |
scorer | Optional object implementing the Scorer protocol ( TYPE: |
share_session | Whether agents share session state during execution. When True (default), uses SequentialAgent. When False, only the primary agent runs in its own session; other agents are not executed. TYPE: |
config | Evolution configuration. If None, uses EvolutionConfig defaults. Its TYPE: |
state_guard | Optional StateGuard instance for validating and repairing state injection tokens in evolved instructions. TYPE: |
component_selector | Optional selector instance or selector name for choosing which components to update. TYPE: |
reflection_agent | Optional ADK agent for proposals. If None, creates a default reflection agent using config.reflection_model (a model string, or a TYPE: |
trajectory_config | Trajectory capture settings (uses defaults if None). TYPE: |
workflow | Optional original workflow structure to preserve during evaluation. When provided, LoopAgent iterations and ParallelAgent concurrency are preserved instead of flattening to SequentialAgent. Used internally by evolve_workflow(); not typically set directly. TYPE: |
session_service | Optional ADK session service for state management. If None (default), creates an InMemorySessionService internally. Pass a custom service (e.g., SqliteSessionService, DatabaseSessionService; on ADK 2.x SQL-backed services need the TYPE: |
app | Optional ADK App instance. When provided, evolution uses the app's configuration. Note that App does not hold services directly; pass a Runner for service extraction, or combine with session_service param. TYPE: |
runner | Optional ADK Runner instance. When provided, evolution extracts and uses the runner's session_service for all agent executions (evolved agents, critic, and reflection agent). Takes precedence over both app and session_service parameters. This enables seamless integration with existing ADK infrastructure. TYPE: |
registry | Optional ComponentHandlerRegistry that resolves every component name; defaults to the default registry that TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
MultiAgentEvolutionResult | MultiAgentEvolutionResult containing evolved_components dict |
MultiAgentEvolutionResult | mapping qualified component names (agent.component format) to their |
MultiAgentEvolutionResult | optimized values, along with score metrics, iteration history |
MultiAgentEvolutionResult | (each record names its |
MultiAgentEvolutionResult | original_components (filtered to the qualified keyspace), |
MultiAgentEvolutionResult | schema_version (4), and stop_reason propagated from the engine |
MultiAgentEvolutionResult | result. |
| RAISES | DESCRIPTION |
|---|---|
ConfigurationError | If pre-flight validation fails: invalid agent names, non-LlmAgent critic, both critic and scorer given, a scorer that does not implement Scorer, empty trainset, duplicate or empty component names per agent, EvolutionConfig consistency errors, or a component name the resolved registry holds no handler for. |
MultiAgentValidationError | If agents dict is empty, primary agent not found, or no scorer and primary lacks output_schema. |
ValueError | If components mapping contains unknown agents or is missing entries for agents. |
EvolutionError | If evolution fails during execution. A reflection call that keeps raising a retryable provider error is skipped with |
Examples:
Basic usage with per-agent components (API v0.3.x):
from google.adk.agents import LlmAgent
from google.adk.models.lite_llm import LiteLlm
from gepa_adk import evolve_group
generator = LlmAgent(
name="generator",
model=LiteLlm(model="ollama_chat/gpt-oss:20b"),
instruction="Generate code based on the requirement.",
)
critic = LlmAgent(
name="critic",
model=LiteLlm(model="ollama_chat/gpt-oss:20b"),
instruction="Review the code in {generator_output}.",
)
validator = LlmAgent(
name="validator",
model=LiteLlm(model="ollama_chat/gpt-oss:20b"),
instruction="Validate the reviewed code.",
output_schema=ValidationResult,
)
result = await evolve_group(
agents={
"generator": generator,
"critic": critic,
"validator": validator,
},
primary="validator",
trainset=training_data,
components={
"generator": ["instruction", "output_schema"],
"critic": ["instruction"],
"validator": ["instruction"],
},
)
# Access evolved components using qualified names
print(result.evolved_components["generator.instruction"])
print(result.evolved_components["critic.instruction"])
print(result.evolved_components["validator.instruction"])
Exclude an agent from evolution:
result = await evolve_group(
agents={"generator": gen, "static_validator": val},
primary="generator",
trainset=training_data,
components={
"generator": ["instruction"],
"static_validator": [], # Excluded from evolution
},
)
Using custom session service for persistence:
# Requires the gepa-adk[db] extra (google-adk[db]) on ADK 2.x
from google.adk.sessions import SqliteSessionService
# Use SQLite for session persistence
session_service = SqliteSessionService(db_path="evolution_sessions.db")
result = await evolve_group(
agents={"generator": gen, "critic": critic},
primary="critic",
trainset=training_data,
session_service=session_service, # Sessions persisted to SQLite
)
Using App/Runner for existing infrastructure integration:
from google.adk.runners import Runner
# Requires the gepa-adk[db] extra (google-adk[db]) on ADK 2.x
from google.adk.sessions import DatabaseSessionService
# Configure Runner with your production session service
runner = Runner(
app_name="my_app",
agent=generator, # Any agent from the group
session_service=DatabaseSessionService(connection_string="..."),
)
# Evolution uses Runner's session_service for all operations
result = await evolve_group(
agents={"generator": gen, "refiner": ref},
primary="refiner",
trainset=training_data,
runner=runner, # Services extracted from runner
)
Notes
Breaking change in v0.3.x: The agents parameter changed from list[LlmAgent] to dict[str, LlmAgent]. Candidate keys now use qualified names (agent.component) instead of {agent_name}_instruction.
For reproducible evolution, pass a seeded config: config=EvolutionConfig(seed=42).
The returned result copies baseline_failed_evaluations, total_failed_evaluations and token_usage from the engine result.
Source code in src/gepa_adk/api.py
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 | |
evolve_workflow async ¶
evolve_workflow(
workflow: SequentialAgent | LoopAgent | ParallelAgent,
trainset: list[dict[str, Any]],
*,
critic: LlmAgent | None = None,
scorer: Scorer | None = None,
primary: str | None = None,
max_depth: int = 5,
config: EvolutionConfig | None = None,
state_guard: StateGuard | None = None,
component_selector: ComponentSelectorProtocol
| str
| None = None,
round_robin: bool = False,
components: dict[str, list[str]] | None = None,
session_service: BaseSessionService | None = None,
app: App | None = None,
runner: Runner | None = None,
registry: ComponentHandlerRegistry | None = None,
) -> MultiAgentEvolutionResult
Evolve LlmAgents within a workflow agent structure.
Discovers all LlmAgent instances within a workflow (SequentialAgent, LoopAgent, or ParallelAgent) and evolves them while preserving the workflow structure. Uses shared session state to maintain workflow context during evaluation.
| PARAMETER | DESCRIPTION |
|---|---|
workflow | Workflow agent containing LlmAgents to evolve. Must be SequentialAgent, LoopAgent, or ParallelAgent. TYPE: |
trainset | Training examples for evaluation. Each example should have an "input" key and optionally an "expected" key. TYPE: |
| PARAMETER | DESCRIPTION |
|---|---|
critic | Optional critic agent for scoring. If None and no scorer is given, the primary agent must have an output_schema for schema-based scoring. Mutually exclusive with scorer. TYPE: |
scorer | Optional object implementing the Scorer protocol ( TYPE: |
primary | Name of the agent to score. Defaults to the last LlmAgent found in the workflow (for sequential workflows, this is typically the final output producer). TYPE: |
max_depth | Maximum recursion depth for nested workflows (default: 5). Limits how deeply nested workflow structures are traversed. TYPE: |
config | Evolution configuration. If None, uses EvolutionConfig defaults. TYPE: |
state_guard | Optional StateGuard instance for validating and repairing state injection tokens in evolved component_text. TYPE: |
component_selector | Optional selector instance or selector name for choosing which components to update. TYPE: |
round_robin | If False (default), only the first discovered agent's instruction is evolved across all iterations. If True, all agents' instructions are evolved in round-robin fashion (the engine cycles through agents each iteration). Ignored when components is provided. TYPE: |
components | Optional per-agent component configuration mapping agent names to lists of component names to evolve. When provided, takes precedence over round_robin. Use empty list to exclude an agent. TYPE: |
session_service | Optional ADK session service for state management. If None (default), creates an InMemorySessionService internally. Pass a custom service (e.g., SqliteSessionService, DatabaseSessionService; on ADK 2.x SQL-backed services need the TYPE: |
app | Optional ADK App instance supplying the session app name when runner is absent. Services come from runner when provided; otherwise evolution uses session_service or InMemorySessionService(). TYPE: |
runner | Optional ADK Runner instance. When provided, evolution extracts and uses the runner's session_service for all agent executions (evolved agents, critic, and reflection agent). Takes precedence over both app and session_service parameters. This enables seamless integration with existing ADK infrastructure. TYPE: |
registry | Optional ComponentHandlerRegistry that resolves every component name; defaults to the default registry that TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
MultiAgentEvolutionResult | MultiAgentEvolutionResult containing evolved_components dict mapping |
MultiAgentEvolutionResult | qualified agent.component names (e.g., "writer.instruction") to their |
MultiAgentEvolutionResult | optimized component_text, along with score |
MultiAgentEvolutionResult | metrics and iteration history (each record names its |
MultiAgentEvolutionResult |
|
| RAISES | DESCRIPTION |
|---|---|
ConfigurationError | If pre-flight validation fails: non-LlmAgent critic, both critic and scorer given, a scorer that does not implement Scorer, empty trainset, duplicate or empty component names, EvolutionConfig consistency errors, or a component name the resolved registry holds no handler for. |
WorkflowEvolutionError | If workflow contains no LlmAgents. |
MultiAgentValidationError | If primary agent not found or no scorer available. |
EvolutionError | If evolution fails during execution. A reflection call that keeps raising a retryable provider error is skipped with |
Examples:
Default behavior (evolve first agent only):
from google.adk.agents import LlmAgent, SequentialAgent
from gepa_adk import evolve_workflow
generator = LlmAgent(name="generator", instruction="Generate code")
refiner = LlmAgent(name="refiner", instruction="Refine code")
writer = LlmAgent(name="writer", instruction="Write docs")
pipeline = SequentialAgent(
name="Pipeline", sub_agents=[generator, refiner, writer]
)
# Only generator.instruction is evolved across all iterations
result = await evolve_workflow(workflow=pipeline, trainset=trainset)
Round-robin evolution (evolve all agents):
# All agents are evolved in round-robin: generator -> refiner -> writer -> ...
result = await evolve_workflow(
workflow=pipeline,
trainset=trainset,
round_robin=True,
)
Explicit components override (takes precedence over round_robin):
# Only generator and writer are evolved; refiner is excluded
result = await evolve_workflow(
workflow=pipeline,
trainset=trainset,
components={
"generator": ["instruction"],
"writer": ["instruction"],
"refiner": [], # Excluded
},
)
Using custom session service for persistence:
# Requires the gepa-adk[db] extra (google-adk[db]) on ADK 2.x
from google.adk.sessions import SqliteSessionService
# Persist workflow evolution sessions to SQLite
session_service = SqliteSessionService(db_path="workflow_sessions.db")
result = await evolve_workflow(
workflow=pipeline,
trainset=trainset,
session_service=session_service,
)
Using App/Runner for existing infrastructure integration:
from google.adk.runners import Runner
# Requires the gepa-adk[db] extra (google-adk[db]) on ADK 2.x
from google.adk.sessions import DatabaseSessionService
# Configure Runner with your production session service
runner = Runner(
app_name="my_workflow_app",
agent=pipeline, # The workflow agent
session_service=DatabaseSessionService(connection_string="..."),
)
# Evolution uses Runner's session_service for all operations
result = await evolve_workflow(
workflow=pipeline,
trainset=trainset,
runner=runner, # Services extracted from runner
)
Notes
Pre-flight validation runs synchronously before any LLM calls. Supports workflow agents (SequentialAgent, LoopAgent, ParallelAgent) with recursive traversal and depth limiting via max_depth parameter. Handles nested structures. LoopAgent and ParallelAgent configurations (max_iterations, etc.) are preserved during evolution. Always uses share_session=True to maintain workflow context (FR-010).
For reproducible evolution, pass a seeded config: config=EvolutionConfig(seed=42).
Source code in src/gepa_adk/api.py
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 | |
evolve async ¶
evolve(
agent: LlmAgent,
trainset: list[dict[str, Any]],
*,
valset: list[dict[str, Any]] | None = None,
critic: LlmAgent | None = None,
scorer: Scorer | None = None,
reflection_agent: LlmAgent | None = None,
config: EvolutionConfig | None = None,
trajectory_config: TrajectoryConfig | None = None,
state_guard: StateGuard | None = None,
candidate_selector: CandidateSelectorProtocol
| str
| None = None,
component_selector: ComponentSelectorProtocol
| str
| None = None,
executor: AgentExecutorProtocol | None = None,
components: list[str] | None = None,
schema_constraints: SchemaConstraints | None = None,
app: App | None = None,
runner: Runner | None = None,
registry: ComponentHandlerRegistry | None = None,
) -> EvolutionResult
Evolve an ADK agent's instruction.
Optimizes the instruction for a single ADK agent using evolutionary optimization. The agent's instruction is iteratively improved based on performance on the training set.
| PARAMETER | DESCRIPTION |
|---|---|
agent | The ADK LlmAgent to evolve. When TYPE: |
trainset | Training examples [{"input": "...", "expected": "..."}]. TYPE: |
| PARAMETER | DESCRIPTION |
|---|---|
valset | Optional validation examples used for scoring and acceptance. Defaults to the trainset when omitted. TYPE: |
critic | Optional ADK agent for scoring (uses schema scoring if None and no scorer is given). Mutually exclusive with scorer. TYPE: |
scorer | Optional object implementing the Scorer protocol ( TYPE: |
reflection_agent | Optional ADK agent for proposals. If None, creates a default reflection agent using config.reflection_model (a model string, or a TYPE: |
config | Evolution configuration (uses defaults if None). Its TYPE: |
trajectory_config | Trajectory capture settings (uses defaults if None). TYPE: |
state_guard | Optional state token preservation settings. TYPE: |
candidate_selector | Optional selector instance or selector name. TYPE: |
component_selector | Optional selector instance or selector name for choosing which components to update. TYPE: |
executor | Optional AgentExecutorProtocol implementation for unified agent execution. When provided, both the ADKAdapter and CriticScorer use this executor for consistent session management and execution. If None, creates an AgentExecutor automatically. An TYPE: |
components | List of component names to include in evolution. Supported: - "instruction": The agent's instruction text (default if None). - "output_schema": The agent's Pydantic output_schema (serialized). - Any other name with a handler in the default component handler registry, such as "generate_content_config" or the keys added by TYPE: |
schema_constraints | Optional SchemaConstraints for output_schema evolution. When provided, proposed schema mutations are validated against these constraints. Mutations that violate constraints (e.g., remove required fields) are rejected and the original schema is preserved. TYPE: |
app | Optional ADK App instance. When provided, evolution uses the app's configuration. Note that App does not hold services directly; pass a Runner for service extraction, or combine with session_service param. See the App/Runner integration guide for details. TYPE: |
runner | Optional ADK Runner instance. When provided, evolution extracts and uses the runner's session_service for all agent executions (evolved agents, critic, and reflection agent). Takes precedence over both app and executor parameters. This enables seamless integration with existing ADK infrastructure. TYPE: |
registry | Optional ComponentHandlerRegistry that resolves every component name; defaults to the default registry that TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
EvolutionResult | The engine's EvolutionResult with evolved_components (after state |
EvolutionResult | guard validation), valset_score, trainset_score and |
EvolutionResult | original_components (each component's seeded text) replaced. Every |
EvolutionResult | other field, including the failed-evaluation counters, stop_reason, |
EvolutionResult | token_usage and objective_scores, comes from the engine unchanged. |
| RAISES | DESCRIPTION |
|---|---|
ConfigurationError | If invalid parameters provided, including pre-flight validation failures: non-LlmAgent agent or critic, both critic and scorer given, a scorer that does not implement Scorer, empty trainset, duplicate or empty component names, missing critic, scorer and output_schema, EvolutionConfig consistency errors, or a component name the resolved registry holds no handler for. |
EvolutionError | If evolution fails during execution. A reflection call that keeps raising a retryable provider error is skipped with |
Notes
Pre-flight validation runs synchronously before any LLM calls. When SchemaBasedScorer is selected and trainset rows carry expected, a scorer.schema_based_over_labelled_trainset warning is logged; the selected scorer does not change. Single-agent evolution with trainset reflection and valset scoring.
For reproducible evolution, pass a seeded config: config=EvolutionConfig(seed=42).
Examples:
Basic usage with output_schema:
from pydantic import BaseModel, Field
from google.adk.agents import LlmAgent
from google.adk.models.lite_llm import LiteLlm
from gepa_adk import evolve
class OutputSchema(BaseModel):
answer: str
score: float = Field(ge=0.0, le=1.0)
agent = LlmAgent(
name="assistant",
model=LiteLlm(model="ollama_chat/gpt-oss:20b"),
instruction="You are a helpful assistant.",
output_schema=OutputSchema,
)
trainset = [
{"input": "What is 2+2?", "expected": "4"},
{"input": "What is the capital of France?", "expected": "Paris"},
]
result = await evolve(agent, trainset)
print(f"Evolved: {result.evolved_components['instruction']}")
With critic agent:
from pydantic import BaseModel, Field
from google.adk.agents import LlmAgent
from google.adk.models.lite_llm import LiteLlm
from gepa_adk import evolve
class CriticOutput(BaseModel):
score: float = Field(ge=0.0, le=1.0)
critic = LlmAgent(
name="critic",
model=LiteLlm(model="ollama_chat/gpt-oss:20b"),
instruction="Score the response quality.",
output_schema=CriticOutput,
)
result = await evolve(agent, trainset, critic=critic)
Evolving output_schema with schema reflection:
from gepa_adk.adapters.agents.reflection_agents import (
create_schema_reflection_agent,
)
# Create schema reflection agent with validation tool
schema_reflector = create_schema_reflection_agent("gemini-3.8-flash")
# Evolve output_schema component
result = await evolve(
agent,
trainset,
critic=critic,
reflection_agent=schema_reflector,
components=["output_schema"], # Evolve schema, not instruction
)
print(f"Evolved schema: {result.evolved_components['output_schema']}")
Using App/Runner for existing infrastructure integration:
from google.adk.apps.app import App
from google.adk.runners import Runner
# Requires the gepa-adk[db] extra (google-adk[db]) on ADK 2.x
from google.adk.sessions import DatabaseSessionService
# Configure Runner with your production session service
session_service = DatabaseSessionService(connection_string="...")
runner = Runner(
app_name="my_app",
agent=agent,
session_service=session_service,
)
# Evolution uses your Runner's session_service for all operations
result = await evolve(
agent,
trainset,
runner=runner, # Services extracted from runner
)
Source code in src/gepa_adk/api.py
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 | |
run_sync ¶
Run an async coroutine synchronously and return its result.
Universal sync wrapper that accepts any coroutine (e.g., evolve(), evolve_group(), evolve_workflow()) and runs it in a blocking manner. Uses asyncio.run() as the primary mechanism, with nest_asyncio as a fallback for environments with a running event loop. The fallback saves and restores the original event loop to avoid polluting the event loop policy state.
| PARAMETER | DESCRIPTION |
|---|---|
coro | A coroutine object to execute (e.g., TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
T | The result of the coroutine execution. The return type matches |
T | the coroutine's return type (e.g., EvolutionResult for evolve(), |
T | MultiAgentEvolutionResult for evolve_group()). |
| RAISES | DESCRIPTION |
|---|---|
TypeError | If |
RuntimeError | If a running event loop is detected and |
Examples:
Single-agent evolution:
Multi-agent group evolution:
from gepa_adk import run_sync, evolve_group
result = run_sync(evolve_group(agents, "primary", trainset=trainset))
Notes
In Jupyter notebooks or IPython, the event loop is already running. Use await evolve(...) directly instead of run_sync(evolve(...)). The nest_asyncio fallback may work but await is preferred.
Source code in src/gepa_adk/api.py
2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 | |
evolve_sync ¶
evolve_sync(
agent: LlmAgent,
trainset: list[dict[str, Any]],
**kwargs: Any,
) -> EvolutionResult
Synchronous wrapper for evolve().
.. deprecated:: Use run_sync(evolve(agent, trainset, ...)) instead.
Runs the async evolve() function in a blocking manner. Handles nested event loops automatically.
| PARAMETER | DESCRIPTION |
|---|---|
agent | The ADK LlmAgent to evolve. TYPE: |
trainset | Training examples. TYPE: |
**kwargs | Optional keyword arguments passed to evolve(). TYPE: |
| PARAMETER | DESCRIPTION |
|---|---|
valset | Optional validation examples for held-out evaluation. TYPE: |
critic | Optional ADK agent for scoring. TYPE: |
reflection_agent | Optional ADK agent for proposals (not yet implemented). TYPE: |
config | EvolutionConfig for customizing evolution parameters. TYPE: |
trajectory_config | TrajectoryConfig for trace capture settings. TYPE: |
state_guard | Optional state token preservation settings. TYPE: |
candidate_selector | Optional selector instance or selector name. TYPE: |
executor | Optional unified agent executor for consistent session management across all agent types. TYPE: |
| RETURNS | DESCRIPTION |
|---|---|
EvolutionResult | EvolutionResult with evolved_components dict and metrics. |
| RAISES | DESCRIPTION |
|---|---|
ConfigurationError | If invalid parameters provided. |
EvolutionError | If evolution fails during execution. A reflection call that keeps raising a retryable provider error is skipped with |
| WARNS | DESCRIPTION |
|---|---|
DeprecationWarning | Always emitted when called. Use |
Examples:
Basic usage in a script:
from pydantic import BaseModel, Field
from google.adk.agents import LlmAgent
from google.adk.models.lite_llm import LiteLlm
from gepa_adk import evolve_sync
class OutputSchema(BaseModel):
answer: str
score: float = Field(ge=0.0, le=1.0)
agent = LlmAgent(
name="assistant",
model=LiteLlm(model="ollama_chat/gpt-oss:20b"),
instruction="You are a helpful assistant.",
output_schema=OutputSchema,
)
trainset = [
{"input": "What is 2+2?", "expected": "4"},
]
result = evolve_sync(agent, trainset)
print(f"Evolved: {result.evolved_components['instruction']}")
With configuration:
from gepa_adk import evolve_sync, EvolutionConfig
config = EvolutionConfig(max_iterations=50)
result = evolve_sync(agent, trainset, config=config)
Notes
Deprecated. Use run_sync(evolve(agent, trainset, ...)) instead. run_sync is a universal wrapper that works with all async evolution functions.
Source code in src/gepa_adk/api.py
2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 | |