-
Notifications
You must be signed in to change notification settings - Fork 0
[Maxim] Voice simulation runs docs #159
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.
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
Open
impoiler
wants to merge
2
commits into
main
Choose a base branch
from
improvement/voice-simulation-testrun
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Binary file added
BIN
+693 KB
...rkflows-via-api-endpoint/evaluate-simulated-voice-agent/single-entry-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+388 KB
...pi-endpoint/evaluate-simulated-voice-agent/trigger-voice-simulation-testrun.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+718 KB
...rkflows-via-api-endpoint/evaluate-simulated-voice-agent/voice-agent-dataset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+497 KB
...api-endpoint/evaluate-simulated-voice-agent/voice-simulation-testrun-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+173 KB
...valuate/how-to/optimize-evaluation-processes/tag-reports/add-tags-to-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+153 KB
...uate/how-to/optimize-evaluation-processes/tag-reports/filter-reports-by-tag.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: Tag test runs | ||
| description: Tag your test runs to group and filter them effectively | ||
| --- | ||
|
|
||
| <Steps> | ||
| <Step> | ||
|
|
||
| Tag any test run by clicking the **Add tags** button in the left sidebar of the run report view. Search and select one or more tags from the dropdown. If a tag doesn't exist, it'll be created automatically. | ||
|
|
||
|  | ||
|
|
||
| </Step> | ||
| <Step> | ||
|
|
||
| Once tagged, filter runs by tag from the runs table. Navigate to the runs page using the **Runs** button in the left sidebar of the Evaluate section. | ||
|
|
||
|  | ||
|
|
||
| </Step> | ||
| </Steps> |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| title: Voice Simulation Runs | ||
| description: Test your Voice Agent's interaction capabilities with realistic voice simulations across thousands of scenarios. | ||
| --- | ||
|
|
||
| ## Test voice agents at scale with simulated conversations | ||
|
|
||
| Run tests with datasets containing multiple scenarios for your voice agent to evaluate performance across different situations. | ||
|
|
||
| <Steps> | ||
|
|
||
| <Step title="Create a dataset for testing"> | ||
| Configure your agent dataset template with: | ||
| - **Agent scenarios**: Define specific situations for testing (e.g., "Update address", "Order an iPhone") | ||
| - **Expected steps**: List the actions and responses you expect | ||
|
|
||
|  | ||
| </Step> | ||
|
|
||
| <Step title="Set up the test run"> | ||
| - Navigate to your voice agent and click **Test** | ||
| - **Simulated session** mode will be pre-selected (voice agents can't be tested in single-turn mode) | ||
| - Select your agent dataset from the dropdown | ||
| - Choose relevant evaluators | ||
|
|
||
| <Note> | ||
| Only built-in evaluators are currently supported for voice simulation runs. Custom evaluators will be available soon. | ||
| </Note> | ||
|
|
||
|  | ||
|
|
||
| </Step> | ||
|
|
||
| <Step title="Trigger the test run"> | ||
| Click **Trigger test run** to start. The system will call your voice agent and simulate conversations for each scenario. | ||
| </Step> | ||
|
|
||
| <Step title="Review results"> | ||
| Each session runs end-to-end for thorough evaluation: | ||
| - View detailed results for every scenario | ||
| - Text-based evaluators assess turn-by-turn call transcription | ||
| - Audio-based evaluators analyze the call recording | ||
|
|
||
|  | ||
| </Step> | ||
|
|
||
| <Step title="Inspect individual entries"> | ||
| Click any entry to see detailed results for that specific scenario. | ||
|
|
||
| By default, test runs evaluate these performance metrics from the recording audio file: | ||
| - **Avg latency**: How long the agent took to respond | ||
| - **Talk ratio**: Agent talk time compared to simulation agent talk time | ||
| - **Avg pitch**: The average pitch of the agent's responses | ||
| - **Words per minute**: The agent's speech rate | ||
|
|
||
|  | ||
| </Step> | ||
|
|
||
| </Steps> | ||
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.
Uh oh!
There was an error while loading. Please reload this page.