|
1 | 1 | --- |
2 | 2 | title: Traffic splitting |
3 | | -subtitle: Roll out assistant versions gradually with canary releases and experiments |
4 | | -description: Split live call traffic between published assistant versions by percentage, so you can canary a new version, run experiments, and roll back instantly. |
| 3 | +subtitle: Roll out assistant versions gradually with canary releases and tests |
| 4 | +description: Split live call traffic between published assistant versions by percentage, so you can canary a new version, run tests, and roll back instantly. |
5 | 5 | slug: assistants/versioning/traffic-splitting |
6 | 6 | --- |
7 | 7 |
|
8 | | -<Note> |
9 | | -**Beta.** Traffic splitting must be enabled for your Vapi organization. Request access through the [beta access form](https://forms.gle/6EfEcCFxvxJTZHDs8). |
10 | | - |
11 | | -The beta includes percentage splits across published versions, sticky routing for repeat callers, the dashboard traffic editor, and the API, which also returns the full history of allocation changes. It does not yet include per-version call metrics, side-by-side version comparisons, or a dashboard view of past splits. To compare versions today, use each call's `assistantVersion` field, which records the version that handled the call and is also a column in call exports. |
12 | | -</Note> |
13 | | - |
14 | 8 | Traffic splitting routes a percentage of an assistant's live calls to each published version you choose. Instead of every call moving to a new version the moment you publish, you decide how much traffic the new version takes, watch how it behaves, and finish or cancel the rollout on your own schedule. |
15 | 9 |
|
16 | 10 | ## Why split traffic |
17 | 11 |
|
18 | 12 | Publishing an assistant changes what every caller hears. A prompt rewrite that reads well can still greet customers the wrong way, mishandle a transfer, or cause regressions in edge cases that review missed. Traffic splitting turns that all-or-nothing moment into a controlled rollout: |
19 | 13 |
|
20 | 14 | - **Canary releases**: Send a small share, such as 10%, of calls to the new version. If its calls look healthy, gradually raise the share to 100%. If they do not, remove it so the previous version immediately takes back the traffic. |
21 | | -- **Experiments**: Run two versions side by side at 50/50 and compare their transcripts, call outcomes, and analysis before committing to either. |
| 15 | +- **Tests**: Run two versions side by side at 50/50 and compare their transcripts, call outcomes, and analysis before committing to either. |
22 | 16 | - **Staged parking**: Publish a version at 0% so it exists in history and is callable by version, without routing any live traffic to it until you are ready. |
23 | 17 |
|
24 | 18 | ## How routing works |
@@ -68,7 +62,7 @@ The traffic pill in the assistant header shows where calls route now. Select the |
68 | 62 |
|
69 | 63 | **An urgent fix during a rollout.** Remember that an explicit split pins traffic: publishing the fix does not route calls to it until you update the split. Publish at 100% if the fix should take everything, or add the fix's version to the split at the share you want. |
70 | 64 |
|
71 | | -**Comparing versions fairly.** Give the candidates equal shares and let repeat-caller affinity keep each customer's experience consistent while the experiment runs. |
| 65 | +**Comparing versions fairly.** Give the candidates equal shares and let repeat-caller affinity keep each customer's experience consistent while the test runs. To review each version's calls, filter your call logs by assistant version in the assistant's Logs tab; each call also records its version in the `assistantVersion` field, which is a column in call exports. |
72 | 66 |
|
73 | 67 | ## Splitting via the API |
74 | 68 |
|
|
0 commit comments