Skip to content

TEST-201 docs: bring Simulations pages up to date with Composer test generation and the run API - #1342

Open
scott-lowe-vapi wants to merge 2 commits into
mainfrom
scottlowe/test-201-simulations-docs-catch-up
Open

scott-lowe-vapi wants to merge 2 commits into
mainfrom
scottlowe/test-201-simulations-docs-catch-up

Conversation

@scott-lowe-vapi

@scott-lowe-vapi scott-lowe-vapi commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Description

Linear: TEST-201. Companion in-repo docs: VapiAI/vapi#23428.

  • Composer
    • New section Generate tests for an assistant (/composer#generate-tests-for-an-assistant): requirements draft → Generate coverage → suite card with mocked tools and not-tested gaps → Run suite, plus edits and a tip to run five or more iterations.
    • Limitations: "Cannot test your agent" is replaced by "Cannot test every behavior".
    • Safety › Deletion no longer claims Composer can delete resources. It has no delete tools; only discard-draft, for your own unpublished draft.
  • Advanced
    • "Mock tool responses" (anchor unchanged) says generated suites come pre-mocked and explains how to review those mocks.
    • New sections: "Handoffs and transfers in simulations", covering the static-handoff refusal and dynamic handoffs, with a gaps table; and "Hooks and call endings", covering the removed customer.speech.timeout and the tester hang-up ending as customer-ended-call.
    • Four troubleshooting rows.
  • Manage (API tabs)
    • The Idempotency-Key header on POST /eval/simulation/run.
    • Run, item and suite filters (suiteId, targetType, targetId, status, simulationId, assistantId, squadId, name).
    • A note that any query parameter switches these lists to { metadata, results }.
  • Quickstart: the unmocked-tools warning now applies to hand-built suites only.
  • Best practices / Run and maintain: one iteration while setting up, then five or more before trusting a pass rate.
  • Overview, Manage, Voice testing: the handoff mentions link to the new limits section.

Evidence

Every behavior was checked against VapiAI/vapi main:

  • Dashboard labels: features/simulationsOnboarding/constants.ts.
  • Idempotency: simulationRunIdempotencyKeyParse.ts and simulationRunIdempotentReplayGet.ts.
  • Filters: simulationRun.types.ts and GetSimulationSuitesDTO.ts.
  • Handoffs and hooks: handoffSimulationRefusalGet.ts and simulationTargetReengagementHooks/.

Testing Steps

  • fern check (5.151.1) passes: 0 errors. The 15 warnings match the untouched main baseline.
  • Check the preview deployment for the changed pages

@lightsage-app

lightsage-app Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Lightsage docs evals

Lightsage could not queue docs evals for this PR.

Docs URL: https://vapi-preview-01a1527c-c7e7-742f-bb13-ed300ead57a9.docs.buildwithfern.com
Commit: d16141f
Reason: No evals are selected for GitHub PR evals. Open Lightsage and enable the GitHub checkbox for at least one eval.

@github-actions

Copy link
Copy Markdown
Contributor

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions

Copy link
Copy Markdown
Contributor

Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/observability/simulations-manage.mdx Outdated
Comment thread fern/observability/simulations-manage.mdx Outdated
Comment thread fern/observability/simulations-manage.mdx Outdated
Comment thread fern/observability/simulations-manage.mdx Outdated
Comment thread fern/observability/simulations-manage.mdx Outdated

@stephenvapiai stephenvapiai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pulling all of this together. A few edit-pass suggestions inline, mostly wording, plus a couple of questions. Most are suggestion blocks you can apply directly.

One item couldn't go inline because the line isn't part of the diff:

fern/observability/simulations-advanced.mdx:4 (frontmatter description): this PR adds the "Handoffs and transfers in simulations" and "Hooks and call endings" sections, but the description (which feeds llms.txt) doesn't mention them. Suggested:

description: "Configure simulation variables, tool mocks, lifecycle webhooks, latency limits, and structured outputs, and see how handoffs and hooks behave in simulations."

Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/composer.mdx Outdated
Comment thread fern/observability/simulations-advanced.mdx
Comment thread fern/observability/simulations-advanced.mdx Outdated
Comment thread fern/test/voice-testing.mdx Outdated
Comment thread fern/observability/simulations-manage.mdx
Comment thread fern/observability/simulations-manage.mdx Outdated
scott-lowe-vapi and others added 2 commits October 21, 2026 23:15
@scott-lowe-vapi
scott-lowe-vapi force-pushed the scottlowe/test-201-simulations-docs-catch-up branch from d16141f to 15fb590 Compare October 22, 2026 06:31
@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants