You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/providers/observability/langfuse.mdx
+36
Original file line number
Diff line number
Diff line change
@@ -76,3 +76,39 @@ To make the most out of this integration, you can now use Langfuse's [evaluation
76
76
77
77
</Step>
78
78
</Steps>
79
+
80
+
## Enrich Traces
81
+
Vapi allows you to enrich Langfuse traces by integrating [Metadata](https://langfuse.com/docs/tracing-features/metadata) and [Tags](https://langfuse.com/docs/tracing-features/tags).
82
+
83
+
By default, we will add the following values to the metadata of each trace:
84
+
85
+
-`call.metadata`
86
+
-`assistant.metadata`
87
+
-`assistantOverrides.metadata`
88
+
-`assistantOverrides.variableValues`
89
+
90
+
### Usage
91
+
You can enhance your observability in Langfuse by adding metadata and tags:
92
+
93
+
**Metadata**
94
+
95
+
Use the [`assistant.observabilityPlan.metadata`](https://docs.vapi.ai/api-reference/assistants/create#request.body.observabilityPlan.metadata) field to attach custom key-value pairs.
- Store user segments ("user_type": "beta_tester")
100
+
- Log environment details ("env": "production")
101
+
102
+
**Tags**
103
+
104
+
Use the [`assistant.observabilityPlan.tags`](https://docs.vapi.ai/api-reference/assistants/create#request.body.observabilityPlan.tags) field to add searchable labels.
105
+
106
+
Examples:
107
+
- Mark important runs ("priority")
108
+
- Group related sessions ("onboarding", "A/B_test")
109
+
- Filter by feature ("voice_assistant")
110
+
111
+
Adding metadata and tags makes it easier to filter, analyze, and monitor your assistants activity in Langfuse.
Copy file name to clipboardExpand all lines: fern/squads/silent-transfers.mdx
+13-4
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,13 @@ slug: squads/silent-transfers
8
8
If you want to allow your call flow to move seamlessly from one assistant to another _without_ the caller hearing `Please hold while we transfer you` here’s what to do:
9
9
10
10
1.**Update the Destination Assistant’s First Message**
11
-
- Set the assistant’s `firstMessage` to an _empty string_.
12
-
- Make sure the `firstMessageMode` is set to `assistant-speaks-first-with-model-generated-message`.
13
-
2.**Trigger the Transfer from the Source Assistant**
11
+
- Set the assistant's `firstMessage` to an _empty string_.
12
+
- Set the assistant's `firstMessageMode` to `assistant-speaks-first-with-model-generated-message`.
13
+
14
+
2.**Update the Squad's assistant destinations messages**
15
+
- For every `members[*].assistantDestinations[*]`, set the `message` property to an _empty string_.
16
+
17
+
3.**Trigger the Transfer from the Source Assistant**
14
18
15
19
- In that assistant’s prompt, include a line instructing it to transfer to the desired assistant:
16
20
@@ -20,7 +24,7 @@ If you want to allow your call flow to move seamlessly from one assistant to ano
20
24
21
25
- Replace `'assistantName'` with the exact name of the next assistant.
22
26
23
-
3.**Direct the Destination Assistant’s Behavior**
27
+
4.**Direct the Destination Assistant’s Behavior**
24
28
- In that assistant’s prompt, include a line instructing it to _`Proceed directly to the Task section without any greetings or small talk.`_
25
29
- This ensures there’s no awkward greeting or “Hello!” when the next assistant begins speaking.
26
30
@@ -38,6 +42,10 @@ Below are the key JSON examples you’ll need. These show how to structure your
38
42
39
43
### **HP Payment Squad With SubAgent**
40
44
45
+
<Warning>
46
+
Make sure the `members[*].assistantDestinations[*].message` properties are set to an _empty string_.
47
+
</Warning>
48
+
41
49
```json
42
50
{
43
51
"members": [
@@ -97,6 +105,7 @@ Below are the key JSON examples you’ll need. These show how to structure your
Copy file name to clipboardExpand all lines: fern/tools/default-tools.mdx
+53-11
Original file line number
Diff line number
Diff line change
@@ -62,9 +62,9 @@ This function is provided when `endCall` is included in the assistant's list of
62
62
}
63
63
```
64
64
65
-
#### Dial Keypad (DTMF)
65
+
#### Send Text
66
66
67
-
This function is provided when `dtmf` is included in the assistant's list of available tools (see configuration options [here](/api-reference/assistants/create#request.body.model.openai.tools.dtmf)). The assistant will be able to enter digits on the keypad.
67
+
This function is provided when `sms` is included in the assistant's list of available tool (see configuration options [here](/api-reference/assistants/create#request.body.model.openai.tools.sms)). The assistant can use this function to send SMS messages using a configured Twilio account.
68
68
69
69
```json
70
70
{
@@ -74,21 +74,24 @@ This function is provided when `dtmf` is included in the assistant's list of ava
74
74
"messages": [
75
75
{
76
76
"role": "system",
77
-
"content": "You are an assistant at a law firm. When you hit a menu, use the dtmf function to enter the digits."
77
+
"content": "You are an assistant. When the user asks you to send a text message, use the sms function."
78
78
}
79
79
],
80
80
"tools": [
81
81
{
82
-
"type": "dtmf"
82
+
"type": "sms",
83
+
"metadata": {
84
+
"from": "+15551234567"
85
+
}
83
86
}
84
87
]
85
88
}
86
89
}
87
90
```
88
91
89
-
#### Send Text
92
+
#### Dial Keypad (DTMF)
90
93
91
-
This function is provided when `sms` is included in the assistant’s list of available tool (see configuration options [here](/api-reference/assistants/create#request.body.model.openai.tools.sms)). The assistant can use this function to send SMS messages using a configured Twilio account.
94
+
This function is provided when `dtmf` is included in the assistant's list of available tools (see configuration options [here](/api-reference/assistants/create#request.body.model.openai.tools.dtmf)). The assistant will be able to enter digits on the keypad.
92
95
93
96
```json
94
97
{
@@ -98,21 +101,60 @@ This function is provided when `sms` is included in the assistant’s list of av
98
101
"messages": [
99
102
{
100
103
"role": "system",
101
-
"content": "You are an assistant. When the user asks you to send a text message, use the sms function."
104
+
"content": "You are an assistant at a law firm. When you hit a menu, use the dtmf function to enter the digits."
102
105
}
103
106
],
104
107
"tools": [
105
108
{
106
-
"type": "sms",
107
-
"metadata": {
108
-
"from": "+15551234567"
109
-
}
109
+
"type": "dtmf"
110
110
}
111
111
]
112
112
}
113
113
}
114
114
```
115
115
116
+
<Note>
117
+
There are three methods for sending DTMF in a phone call:
118
+
119
+
1.**In-band DTMF**: DTMF tones are transmitted as part of the regular audio stream. This is the simplest method, but it can suffer from quality issues if the audio stream is compressed or degraded.
120
+
2.**Out-of-band DTMF via RFC 2833**: This method sends DTMF tones separately from the audio stream, within RTP (Real-Time Protocol) packets. It's typically more reliable than in-band DTMF, particularly for VoIP applications where the audio stream might be compressed. RFC 2833 is the standard that initially defined this method. It is now replaced by RFC 4733 but this method is still referred by RFC 2833.
121
+
3.**Out-of-band DTMF via SIP INFO messages**: In this approach, DTMF tones are sent as separate SIP INFO messages. While this can be more reliable than in-band DTMF, it's not as widely supported as the RFC 2833 method.
122
+
123
+
As of writing, Vapi's DTMF tool uses in-band DTMF. Please note that this method may not work with certain IVRs. If you are running into this issue, the recommended approach is to have your assistant say the options out loud if available. For example, when an IVR says "Press 1 or say Sales for the Sales department," prefer having the assistant say "Sales."
124
+
</Note>
125
+
126
+
#### Send Text
127
+
128
+
1.**In-band**: tones are transmitted as part of the regular audio stream. This is the simplest method, but it can suffer from quality issues if the audio stream is compressed or degraded.
129
+
2.**Out-of-band via RFC 2833**: tones are transmitted separately from the audio stream, within RTP (Real-Time Protocol) packets. It's typically more reliable than in-band DTMF, particularly for VoIP applications where the audio stream might be compressed. RFC 2833 is the standard that initially defined this method. It is now replaced by RFC 4733 but this method is still referred by RFC 2833.
130
+
3.**Out-of-band via SIP INFO messages**: tones are sent as separate SIP INFO messages. While this can be more reliable than in-band DTMF, it's not as widely supported as the RFC 2833 method.
131
+
132
+
<Note>
133
+
Vapi's DTMF tool uses in-band method. Please note that this method may not work with certain IVRs. If you are running into this issue, the recommended approach is to have your assistant say the options out loud if available. For example, when an IVR says "Press 1 or say Sales for the Sales department," prefer having the assistant say "Sales."
134
+
</Note>
135
+
136
+
##### Tool Effectiveness
137
+
138
+
To evaluate this tool, we set up a Vapi assistant with the DTMF tool enabled and conducted calls to a range of IVR systems, including a Twilio IVR (configured via Studio Flows) and several third-party IVRs such as pharmacies and insurance companies.
139
+
140
+
**Testing Methodology**
141
+
142
+
We called and navigated through the IVRs using three different strategies:
143
+
144
+
1.**Direct Dialpad**: calling from a personal phone and dialing options using the dialpad.
145
+
2.**Vapi DTMF Tool**: an assistant configured with the DTMF tool.
146
+
3.**Manual DTMF Sound**: calling from a personal phone and playing DTMF tones generated by software. _(similar approach as the Vapi DTMF Tool)_
147
+
148
+
**Key Findings**
149
+
150
+
- The assistant successfully navigated some of the third-party IVRs.
151
+
- The assistant encountered issues with Twilio IVRs, likely due to Twilio’s preference for RFC 2833.
152
+
- Observed occasional delays in DTMF tone transmission, which may affect effectiveness with IVRs that have short timeouts.
153
+
154
+
**Conclusion**
155
+
156
+
The tool's effectiveness depends on the IVR system's configuration and DTMF capturing method. We are working to improve compatibility and reduce transmission delays for broader and more reliable support.
subtitle: Dynamic AI-driven branching in workflows
3
+
subtitle: Smart workflow branching powered by AI
4
4
slug: /workflows/edges/ai-conditions
5
5
---
6
6
7
7
## Overview
8
8
9
-
The **AI Conditions** feature leverages artificial intelligence to determine the next step in your workflow based on conversation context. Unlike traditional logical conditions—which rely on explicit rules—AI Conditions allow your voice agent to evaluate complex or ambiguous scenarios, making branching decisions dynamically.
9
+
AI Conditions use artificial intelligence to decide the next step in your workflow based on the conversation. Instead of using fixed rules, they can understand complex situations and make smart decisions in real-time.
10
10
11
11
## How It Works
12
12
13
-
-**Contextual Evaluation:**The AI considers data from previous steps (e.g., user input, API responses) to gauge the conversation context.
14
-
-**Adaptive Decision-Making:** It uses its judgment to choose the most appropriate branch without relying solely on fixed comparisons.
15
-
-**Seamless Integration:** AI Conditions can complement existing logical conditions, offering a balance between predictable rules and adaptive behavior.
13
+
1.The AI looks at the conversation history and context
14
+
2. It makes a smart decision about which path to take, based on variables collected from Gather verbs and data returned from API requests.
15
+
3. Works alongside your existing rules for maximum flexibility
16
16
17
-
## Configuration
18
17
19
-
-**Activation:** Enable AI Conditions on a condition node where you want the AI to drive the branching logic.
20
-
-**Context Input:** The AI will utilize variables collected from Gather verbs and data returned from API requests.
21
-
-**Decision Logic:** No manual rules are required—the AI interprets context in real time to select the optimal branch.
22
-
-**Fallback:** You can combine AI Conditions with traditional logical conditions for added control.
18
+
## Configuration
19
+
-**Condition Node:** Start by inserting a condition node into your workflow.
20
+
-**Branch Setup:** Attach one or more nodes to the condition node.
21
+
-**AI Tag:** Click on the connecting edge and choose `AI` from the `Condition Type` dropdown
22
+
-**AI Condition** Use the input to define when the chosen branch should be taken.
23
23
24
24
## Usage
25
25
26
-
Deploy AI Conditions when your workflow requires flexibility and context-sensitive decision-making, such as:
27
-
28
-
- Handling ambiguous or multi-faceted user responses.
29
-
- Addressing scenarios where strict rules may not capture the conversation's nuances.
30
-
- Enhancing the user experience by providing more natural, human-like interactions.
31
-
32
-
For detailed configuration instructions and best practices, please refer to our dedicated documentation on AI-driven workflows.
26
+
Use AI Conditions when you need:
27
+
- To handle unclear or complex user responses
28
+
- More flexibility than traditional rules can provide
Copy file name to clipboardExpand all lines: fern/workflows/edges/logical-conditions.mdx
+14-2
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,22 @@ Logical Conditions enable you to create branching paths within your workflow. Th
12
12
13
13
-**Condition Node:** Start by inserting a condition node into your workflow.
14
14
-**Branch Setup:** Attach one or more nodes to the condition node.
15
-
-**Logic Tag:** Click the "Logic" tag on each connecting edge to define rules or comparisons (e.g., equals, greater than) using variables collected from previous steps.
15
+
-**Logic Tag:** Click the "Logic" tag on each connecting edge and select `Logic` from the `Condition Type` dropdown.
16
+
-**Condition Type:** Choose between requiring ALL conditions to be met (AND logic) or ANY condition to be met (OR logic)
17
+
-**Logic Conditions** Use the panel to define one or more rules or comparisons (e.g., equals, greater than) using variables collected from previous steps.
18
+
19
+
<Note>
20
+
To remove a comparison, click on the Trash icon to the right of the comparison.
Implement Logical Conditions to guide your conversation dynamically. They allow your workflow to adjust its path based on real-time data, ensuring more personalized and responsive interactions.
20
30
21
-
For detailed configuration instructions and advanced usage, please refer to our dedicated documentation on condition configuration.
31
+
<Note>
32
+
When [`Gathering`](/workflows/nodes/gather) string values that will be used in conditions, consider using `enum` types to ensure consistent value comparison. This helps prevent issues with case sensitivity, whitespace, or formatting differences that could affect condition evaluation.
![dev-docs-github-app[bot]](https://avatars.githubusercontent.com/in/975135?v=4&size=40){kind=avatar}
0 commit comments