Skip to content

Added a new section on configuring the AI tester. - #1172

Merged
stephenvapiai merged 5 commits into
mainfrom
docs/configure-ai-tester
Aug 27, 2026
Merged

Added a new section on configuring the AI tester. #1172
stephenvapiai merged 5 commits into
mainfrom
docs/configure-ai-tester

Conversation

@stephenvapiai

Copy link
Copy Markdown
Contributor

Description

  • Added a new section on configuring the AI tester.

Testing Steps

  • [ X] Run the app locally using fern docs dev or navigate to preview deployment
  • [ X] Ensure that the changed pages and code snippets work

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

@scott-lowe-vapi scott-lowe-vapi left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Nice addition. The dashboard flow and remaining API examples match current behavior. I left three focused comments.

-H "Authorization: Bearer $VAPI_API_KEY"
```

Then update the personality with `PATCH`. The following request shows representative settings for the model, Soniox transcriber, Vapi Voice, and conversation behavior:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Built-in personalities can be fetched here, but the API rejects PATCH updates to them. Since the quickstart sends users from a default personality to this page, could we add a branch: POST an org-owned copy when orgId is null, otherwise PATCH?

| **Transcriber** | Provider, model, and language | Language detection and hints, endpoint delay, vocabulary, contextual hints, and fallback transcribers |
| **Voice** | Provider and voice ID | Speed, version, language, pronunciation dictionaries, chunking, formatting, and caching |

Transcriber and voice settings apply to voice simulations. Chat simulations use the model only.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Chat simulations also honor firstMessage and who starts first. Could we say: ‘Chat simulations ignore transcriber and voice settings; behavior, model, and turn-taking still apply.’

},
"stopSpeakingPlan": {
"numWords": 2,
"voiceSeconds": 0.2,

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

voiceSeconds is only used when numWords is 0, so it has no effect in this example. Could we remove it or set numWords to 0?

@github-actions

Copy link
Copy Markdown
Contributor

- Use 'assistant or squad under test' instead of 'target-assistant'
- Map Behavior/Model/Transcriber/Voice settings to the Personality tab
- Bridge the Dashboard 'intent' field to the API instructions field
- Use 'success criteria' consistently in the cURL section

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

@stephenvapiai
stephenvapiai merged commit bc1b1c9 into main Aug 27, 2026
6 checks passed
@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.

2 participants