docs: add guide for email address reading in voice agents#1024
Merged
docs: add guide for email address reading in voice agents#1024
Conversation
Adds a comprehensive guide covering how to configure voice agents to collect, read back, and confirm email addresses clearly. Includes copy-pasteable system prompt examples, references to Vapi's built-in formatEmails voice formatter, and best practices for the full collection-and-confirmation conversation flow. Resolves DEVREL-621. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🌿 Preview your docs: https://vapi-preview-6821882c-9115-4de6-a188-98a4d06b6d6a.docs.buildwithfern.com |
Expand the email address reading guide with a technical API configuration section covering: - Full 14-step voice formatting pipeline table showing where formatEmails (step 8) fits - FormatPlan TypeScript type definition - Code examples (JSON, TypeScript SDK, Python SDK) for enabling specific formatters, disabling email formatting selectively, and disabling all formatting - Note on formattersEnabled introduction date (2025-02-20) - Updated overview to describe three solution layers (built-in formatting, API configuration, prompt engineering) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
🌿 Preview your docs: https://vapi-preview-fd30f9e1-02cc-49a7-adc0-6c8963c92af6.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
1 participant
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.
Description
fern/assistants/email-address-reading.mdxthat explains how to configure AI voice agents to collect, read back, and confirm email addresses clearlydocs.ymlunder Assistants > Conversation behavior (after "Pronunciation dictionaries")formatEmailsvoice formatting step that already handles TTS-level character replacementResolves DEVREL-621
Testing Steps
fern docs devor navigate to preview deploymentfern checkpasses with 0 errors (5 pre-existing warnings unrelated to this change)