Skip to content

Added best practices for language selection #1346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephenvapiai merged 1 commit into from
Oct 19, 2026
Merged

Added best practices for language selection #1346

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion fern/observability/simulations-configure-ai-tester.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,14 @@ Chat simulations ignore transcriber and voice settings. Behavior, model, and tur
</Step>

<Step title="Configure voice settings">
For a voice simulation, configure these optional settings:
For a voice simulation, configure these optional settings by expanding **Advanced settings**:

- Under **Transcriber**, select the speech-to-text provider, language, and model.
- Under **Voice**, select the provider and voice, or enter a custom voice ID.

<Note>
Set the AI tester's transcriber to match the language used by the assistant or squad you're testing, or use a transcriber that supports [automatic language detection](/customization/multilingual#configure-automatic-language-detection). Otherwise, the AI tester may not understand the replies and may repeat the same questions. Also select a model and voice that support the same language.
</Note>
</Step>

<Step title="Continue configuring the suite">
Expand Down Expand Up @@ -161,6 +165,10 @@ curl -X PATCH "https://api.vapi.ai/eval/simulation/personality/<personality-id>"
}'
```

<Note>
For a voice simulation, set the AI tester's `transcriber` to match the language used by the assistant or squad you're testing, or use a transcriber that supports [automatic language detection](/customization/multilingual#configure-automatic-language-detection). Otherwise, the AI tester may not understand the replies and may repeat the same questions. Also set a `model` and `voice` that support the same language. The transcriber's language field varies by provider, such as `language` for Deepgram or `language` and `languages` for Soniox.
</Note>

Within a personality's `assistant` configuration, `assistant-speaks-first` means the AI tester starts the conversation. Use `assistant-waits-for-user` when the assistant or squad under test should start.

In `stopSpeakingPlan`, `voiceSeconds` only applies when `numWords` is `0`. When `numWords` is greater than `0`, the AI tester waits for that number of transcribed words instead. See [**Stop speaking plan**](/customization/voice-pipeline-configuration#stop-speaking-plan) for details.
Expand Down
Loading