docs(evals): document DTMF turns and reorganize the scenarios page#934
Merged
Conversation
Cover the new scenario-format features for evals: - `dtmf:` turns: pressing keypad keys as an alternative to `user:`, how a DTMFAggregator turns them into a transcription, and the `#`-terminator vs idle-timeout flush. - `send_after:` without an event: a pure time delay for pacing input. Rename the section to "Scheduling input with `send_after:`" so the field is discoverable, not buried under "Interruptions". - Note that DTMF turns emit user_* events in either modality. Also clarify that the eval transport suppresses on_client_disconnected, and remove em dashes from the page's prose.
…tions Restructure the page around four top-level sections: - Configuration (now first): all scenario-wide setup, including the text/audio modes overview, `user:` delivery, `judge:`, `factory:`, `context:`, `!include`, and back-to-back / disconnect lifecycle. - Input: per-turn authoring only (user turns, dtmf, vision, send_after). - Events / Assertions: kept as separate sections. Splits the two meanings of `user:` cleanly (the top-level delivery block lives in Configuration, the per-turn utterance field in Input) and cross- links the `eval:` assertion to the judge LLM that decides it.
- "Input" section becomes "User turns", since dtmf and image turns are also user turns. Subsections are now the ways a turn drives the agent: "Utterances with `user:`", "DTMF keypresses with `dtmf:`", "Vision with `image:`", "Scheduling with `send_after:`". - Use a trailing colon whenever a heading or prose names a YAML key, so `eval:`, `text_contains:`, and `within_ms:` match the block headings.
Contributor
|
🔍 Mintlify preview for this branch: https://daily-aleix-eval-dtmf-docs.mintlify.app |
markbackman
reviewed
Jun 23, 2026
| - event: response | ||
| eval: "describes the weather and recommends a restaurant" | ||
| ``` | ||
| The rest of this page is in four parts: [Configuration](#configuration) for scenario-wide setup (modalities, the judge, context, lifecycle), then [User turns](#user-turns) for driving each turn, and [Events](#events) and [Assertions](#assertions) for checking what the agent emits. |
Contributor
There was a problem hiding this comment.
I think you should make these cards or something that's more visual. It will break up the page and make this part easier to scan.
markbackman
approved these changes
Jun 23, 2026
markbackman
left a comment
markbackman
left a comment
Contributor
There was a problem hiding this comment.
Really nice clean up. Just one suggestion.
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
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.
Summary
Documents the new evals scenario-format features from the pipecat
aleix/eval-dtmfwork, and reorganizes the scenarios page so the format reads as a coherent whole.New features documented
dtmf:): pressing keypad keys as an alternative touser:(mutually exclusive). Covers how aDTMFAggregatorturns keys into a transcription that drives a full user turn, the#-terminator vs idle-timeout flush, valid keys, and the YAML quoting gotcha.send_after:delays: theevent:anchor is now optional, sosend_after: { delay_ms: N }is a pure time delay (useful for pacing DTMF keypresses). A zero-delay no-event form is rejected.user_transcription/user_started_speaking/user_stopped_speakingalso fire on DTMF turns in either modality, not just audio mode.Reorganization
The page is now four top-level parts:
user:delivery,judge:,factory:,context:,!include, and back-to-back / disconnect lifecycle.user:,dtmf:,image:,send_after:).This splits the two meanings of
user:cleanly (the top-level delivery block lives in Configuration, the per-turn utterance in User turns) and cross-links theeval:assertion to the judge LLM that decides it.Housekeeping
eval:,text_contains:,within_ms:).mint broken-linkspasses; prettier-clean.🤖 Generated with Claude Code