Adk Evals

botpress/skills/skills/adk-evals

作者 botpress9085e5d2c173MIT12 个星标收录于 2026年10月8日更新于 2026年10月8日仓库6天前更新

Complete reference for writing, running, and iterating on evals (automated conversation tests) for ADK agents. Covers eval file format, all assertion types, CLI usage, and per-primitive testing patterns.

AI 生成的概览

为 ADK 智能体编写、运行和调试自动化对话评估的参考指南。

功能
说明 ADK 评估文件格式、断言类别、轮次类型、setup 与 outcome 块以及 CLI 命令。还涵盖针对 action、tool、workflow、conversation 和 state 的分原语测试模式,以及“编写—运行—查看轨迹—迭代”的循环和 CI 集成建议。它输出的是说明和示例评估定义,本身不执行任何内容。
适用场景
当开发者询问如何为 ADK 机器人编写、运行、筛选或调试评估,或如何测试工具、工作流、状态等具体原语时使用。也适用于在 CI 中运行评估或解读失败断言的问题。
运行要求
无需脚本或运行时依赖,仅为说明文档加三份参考文件。它假定使用者熟悉 ADK CLI(adk dev、adk evals)和 @botpress/evals 包,且所描述的评估针对运行中的开发机器人执行。

ADK Evals Skill

What are Evals?

Evals are automated conversation tests for ADK agents. Each eval defines a scenario — a sequence of user messages or events — and asserts on what the bot should do: what it says, which tools it calls, how state changes, which workflows run, and more.

Evals run against a live dev bot (adk dev), so they test the full stack — not mocks.

When to Use This Skill

Use this skill when the developer asks about:

  • Writing evals — file format, assertions, turn types, setup
  • Running evals — CLI commands, filtering, output interpretation
  • Testing specific primitives — how to test actions, tools, workflows, conversations, state
  • The testing loop — write → run → inspect traces → iterate
  • CI integration — exit codes, --format json flag, tagging strategies
  • Eval configuration — idleTimeout, judgePassThreshold, judgeModel

Or when you are developing an ADK bot and need to write the equivalent of unit/end-to-end tests.

Trigger questions:

  • "How do I write an eval?"
  • "How do I test my workflow?"
  • "How do I assert that a tool was called with specific params?"
  • "My eval is failing, how do I debug it?"
  • "How do I test that the bot stays silent?"
  • "How do I run evals in CI?"
  • "How do I seed state before an eval?"
  • "How do I trigger a workflow in an eval?"

Available Documentation

FileContents
references/eval-format.mdComplete file format — all fields, turn types, assertion categories, match operators, setup, outcome, options
references/testing-workflow.mdRunning evals, interpreting output, using traces, the write → test → iterate loop, CI integration
references/test-patterns.mdPer-primitive patterns for actions, tools, workflows, conversations, and state

How to Answer

  1. Writing an eval → Read eval-format.md for structure and assertions
  2. Running evals → Read testing-workflow.md for CLI commands and output
  3. Testing a specific primitive → Read test-patterns.md for the relevant section
  4. Debugging a failure → Combine testing-workflow.md (inspect traces) + eval-format.md (check assertion syntax)

Quick Reference

Eval file structure

typescript
import { Eval } from '@botpress/evals'
export default new Eval({  name: 'greeting',  type: 'regression',  tags: ['basic'],
  setup: {    state: { bot: { welcomeSent: false } },    workflow: { trigger: 'onboarding', input: { userId: 'test-1' } },  },
  conversation: [    {      user: 'Hi!',      assert: {        response: [{ not_contains: 'error' }, { llm_judge: 'Response is friendly and offers to help' }],        tools: [{ not_called: 'createTicket' }],        state: [{ path: 'conversation.greeted', equals: true }],      },    },  ],
  outcome: {    state: [{ path: 'conversation.greeted', equals: true }],  },
  options: {    idleTimeout: 60000,    judgePassThreshold: 4,  },})

Turn types

TurnWhen to use
user: 'message'Standard user message
event: { payload }Push a custom event (arrives as chat:custom)
expectSilence: trueAssert bot does NOT respond

Assertion categories

CategoryWhat it checks
responseBot reply text (contains, not_contains, matches, llm_judge)
toolsTool calls (called, not_called, call_order, params)
stateBot/user/conversation state (equals, changed)
workflowWorkflow execution (entered, completed)
timingResponse time in ms (lte, gte)

CLI commands

bash
adk evals                        # run all evalsadk evals <name>                 # run one evaladk evals --tag <tag>            # filter by tagadk evals --type regression      # filter by typeadk evals --verbose              # show all assertionsadk evals --format json          # JSON output for CI
adk evals runs                   # list recent runsadk evals runs --latest          # most recent runadk evals runs --latest -v       # with full details

Critical Patterns

✅ Every turn needs user or event

typescript
// CORRECT{ user: 'hello', expectSilence: true }{ event: { payload: { kind: 'payment.failed' } }, expectSilence: true }

❌ expectSilence alone is not a valid turn

typescript
// WRONG — missing user or event{  expectSilence: true}

✅ Assert tool params to verify correct extraction

typescript
// CORRECT — verifies the LLM extracted the right values{ called: 'createTicket', params: { priority: { equals: 'high' } } }

❌ Only asserting the tool was called

typescript
// INCOMPLETE — doesn't verify params were correct{  called: 'createTicket'}

✅ Use outcome for post-conversation state and workflow assertions

typescript
// CORRECT — final state checked once after all turnsoutcome: {  state: [{ path: 'conversation.resolved', equals: true }],  workflow: [{ name: 'ticketFlow', completed: true }],}

✅ Seed state to test conditional behavior without running setup turns

typescript
// CORRECT — start in a known statesetup: {  state: {    user: { plan: 'pro' },    conversation: { phase: 'support' },  },}

❌ Using conversation turns to set up state (slow and fragile)

typescript
// WRONG — depends on the bot correctly processing setup turnsconversation: [  { user: 'I am on the pro plan' }, // hoping bot sets user.plan  { user: 'I need help with billing' }, // actual test turn]

Example Questions

Writing evals:

  • "Write an eval that tests my createTicket tool is called with the right priority"
  • "How do I assert that the bot stays silent after an internal event?"
  • "How do I test a multi-turn conversation where context is retained?"

Running evals:

  • "How do I run only regression evals?"
  • "How do I see which assertions failed and why?"
  • "How do I integrate evals into GitHub Actions?"

Debugging:

  • "My eval says the tool wasn't called but I think it was — how do I check?"
  • "How do I inspect what the bot actually did during an eval?"

Per-primitive:

  • "How do I test a workflow that uses step.sleep()?"
  • "How do I test that state changed from the seeded value?"

Response Format

Match depth to the question.

Simple questions ("what assertions are available?", "how do I run evals?")

Answer directly — show the relevant table or CLI command. Don't generate a full eval file for an informational question.

Writing an eval

  1. Show the complete new Eval({}) call with realistic field values
  2. Include imports (import { Eval } from '@botpress/evals')
  3. Briefly explain non-obvious assertions — skip if the assertion is self-explanatory
  4. Suggest the CLI command to run it: adk evals <name>

Debugging a failing eval

  1. Ask for or show the failing assertion (expected / actual diff)
  2. Suggest opening traces in the Dev Console to see what the bot did
  3. Identify whether the issue is in the eval assertion or the bot's behavior

来源与署名

来源:botpress/skills位于skills/adk-evals提交9085e5d

许可证: MIT

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架