Repository navigation
TEST-61 Document background sound for simulations - #1384
Open
scott-lowe-vapi wants to merge 1 commit into
Open
scott-lowe-vapi wants to merge 1 commit into
scott-lowe-vapi wants to merge 1 commit into
Conversation
scott-lowe-vapi
force-pushed
the
scott/test-61-sim-background-sound-docs
branch
from
November 1, 2026 03:15
656ce74 to
5d80e13
Compare
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a1951b-3813-775b-a0eb-36ff38477e3e.docs.buildwithfern.com |
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a1951c-790a-75f8-8aac-d8c8eee92f0c.docs.buildwithfern.com |
scott-lowe-vapi
marked this pull request as ready for review
November 2, 2026 18:35
|
|
||
| ## Background sound | ||
|
|
||
| Add background sound to a voice simulation to test how the assistant or squad you're testing handles a caller in a noisy place. The AI tester plays the sound throughout the call, mixed with its speech. Chat simulations ignore background sound. |
Contributor
There was a problem hiding this comment.
Suggest opening with a definition sentence so the section answers "what is background sound" directly. Also suggest moving the GPT-Live warning up here so GPT-Live users see the limitation before they set anything up, and using the docs' standard "GPT-Live" name with a link. If you accept this, delete the original warning at lines 237–239.
Suggested change
| Add background sound to a voice simulation to test how the assistant or squad you're testing handles a caller in a noisy place. The AI tester plays the sound throughout the call, mixed with its speech. Chat simulations ignore background sound. | |
| Background sound is an audio file that the AI tester plays throughout a voice simulation, mixed with its speech. Use it to test how the assistant or squad you're testing handles a caller in a noisy place. Chat simulations ignore background sound. | |
| <Warning> | |
| [GPT-Live](/gpt-live/overview) AI testers add background sound only while they're speaking, not during silence. They also don't play the built-in `office` value, so use the hosted **Office** preset URL instead. | |
| </Warning> |
|
|
||
| Include the rest of the personality's assistant configuration in the same request, as described in [Configure the AI tester](#configure-the-ai-tester). | ||
|
|
||
| <Note> |
Contributor
There was a problem hiding this comment.
Could the steps for hearing the raw noise (lines 221–234) move out of the Note and into the section text?
| Include the rest of the personality's assistant configuration in the same request, as described in [Configure the AI tester](#configure-the-ai-tester). | ||
|
|
||
| <Note> | ||
| The assistant or squad you're testing denoises incoming audio before it transcribes and records the call. Smart denoising is on by default, so it removes most of the background sound and the recording can sound clean. This is expected, because the simulation tests your production setup. |
Contributor
There was a problem hiding this comment.
Suggest "Smart Denoising" to match the denoising page, and naming what "This" refers to.
Suggested change
| The assistant or squad you're testing denoises incoming audio before it transcribes and records the call. Smart denoising is on by default, so it removes most of the background sound and the recording can sound clean. This is expected, because the simulation tests your production setup. | |
| The assistant or squad you're testing denoises incoming audio before it transcribes and records the call. Smart Denoising is on by default, so it removes most of the background sound, and the recording may sound clean. A clean recording is expected, because the simulation tests your production setup. |
| <Note> | ||
| The assistant or squad you're testing denoises incoming audio before it transcribes and records the call. Smart denoising is on by default, so it removes most of the background sound and the recording can sound clean. This is expected, because the simulation tests your production setup. | ||
|
|
||
| To hear the raw noise, turn off denoising in the scenario's `targetOverrides`. Set `backgroundDenoisingEnabled` as well, because this legacy flag takes precedence when the target sets it: |
Contributor
There was a problem hiding this comment.
Suggest giving the value, and using "the assistant or squad you're testing" as the rest of the page does instead of "the target".
Suggested change
| To hear the raw noise, turn off denoising in the scenario's `targetOverrides`. Set `backgroundDenoisingEnabled` as well, because this legacy flag takes precedence when the target sets it: | |
| To hear the raw noise, turn off denoising in the scenario's `targetOverrides`. Also set `backgroundDenoisingEnabled` to `false`, because this legacy flag takes precedence when the assistant or squad you're testing sets it: |
| } | ||
| ``` | ||
|
|
||
| If the target enables [Fourier denoising](/documentation/assistants/conversation-behavior/background-speech-denoising#fourier-denoising-experimental), also set `backgroundSpeechDenoisingPlan.fourierDenoisingPlan.enabled` to `false`. Updating a scenario replaces its `targetOverrides`, so include any existing overrides you want to keep. |
Contributor
There was a problem hiding this comment.
Same wording swap as line 221.
Suggested change
| If the target enables [Fourier denoising](/documentation/assistants/conversation-behavior/background-speech-denoising#fourier-denoising-experimental), also set `backgroundSpeechDenoisingPlan.fourierDenoisingPlan.enabled` to `false`. Updating a scenario replaces its `targetOverrides`, so include any existing overrides you want to keep. | |
| If the assistant or squad you're testing enables [Fourier denoising](/documentation/assistants/conversation-behavior/background-speech-denoising#fourier-denoising-experimental), also set `backgroundSpeechDenoisingPlan.fourierDenoisingPlan.enabled` to `false`. Updating a scenario replaces its `targetOverrides`, so include any existing overrides you want to keep. |
stephenvapiai
approved these changes
Nov 2, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
scott-lowe-vapi
force-pushed
the
scott/test-61-sim-background-sound-docs
branch
from
November 2, 2026 21:58
5d80e13 to
fd8b58a
Compare
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a19e46-d38f-71cc-be63-2d8f6ca464a1.docs.buildwithfern.com |
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
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.
Support background noise in voice sims
Description
Documents the dashboard control for background sound in voice simulations. Changes docs only.
observability/simulations-configure-ai-tester: moves background sound from API-only to the Dashboard column and adds a## Background soundsection (anchor#background-sound, which the dashboard links to). It covers the toggle in the personality's advanced settings, the six bundled presets and their API values (toggle defaults to White noise; Office is about 18 dB quieter than the rest), custom HTTPS URLs (1,000-character URL, 25 MB file, loops, WAV preferred), and the API fieldpersonality.assistant.backgroundSound. It includes a note on target denoising and how to turn it off throughtargetOverridesto hear the raw noise, plus a warning about the GPT Live (realtime) limitation.assistants/background-speech-denoising: one line under best practices saying denoising also applies when a simulation tester plays background sound.test/simulations-best-practices: one bullet recommending a noisy-caller scenario.Merge order: merge after the VapiAI/vapi PR "TEST-61 Bundle named background sounds for calls and sims" (number to follow) ships to production, and at or before VapiAI/vapi#25265.
Testing Steps
fern check(pinned 5.151.1): 0 errors#fourier-denoising-experimentaland#configure-the-ai-testerexist on the live site#background-soundanchor, presets table, and nested JSON in the note render correctly🤖 Generated with Claude Code