Skip to content

Commit e501567

Browse files
humfordskeptrunedev
authored andcommitted
VAP-3003: [Docs] Restructure top-level sidebar categories to align with new dashboard information hierarchy (#201)
* move SDKs * tool restructuring * new assistants * more restructuring * restructure sidebar
1 parent 8cc98d4 commit e501567

File tree

7 files changed

+307
-137
lines changed

7 files changed

+307
-137
lines changed

fern/GHL.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: How to Connect Vapi with Make & GHL
3-
slug: GHL
3+
slug: tools/GHL
44
---
55

66

fern/assistants.mdx

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,58 @@ subtitle: The core building-block of voice agents on Vapi.
44
slug: assistants
55
---
66

7+
**Assistant** is a fancy word for an AI configuration that can be used across phone calls and Vapi clients. Your voice assistant can augment your customer support and
8+
experience for call centers, business websites, mobile apps, and much more.
79

8-
**Assistant** is a fancy word for an AI configuration that can be used across phone calls and Vapi clients. Your voice assistant can augment your customer support and experience for call centers, business websites, mobile apps, and much more.
10+
## Core Components
911

10-
There are three core components: **Transcriber**, **Model**, and **Voice**. These can be configured, mixed, and matched for your use case. <br /> <Info> There are also various other configurable properties you can find [here](/api-reference/assistants/create-assistant) </Info> Below, check out some ways you can layer in powerful customizations and features to meet any use case.
12+
There are three core components that make up an assistant:
13+
14+
- **Transcriber**: Converts spoken audio into text
15+
- **Model**: The AI model that processes the text and generates responses
16+
- **Voice**: The voice that speaks the AI's responses
17+
18+
These components can be configured, mixed, and matched for your specific use case.
19+
20+
<Info>
21+
View all configurable properties in the [API Reference](/api-reference/assistants/create-assistant)
22+
</Info>
23+
24+
## Key Features
25+
26+
### Dynamic Variables
27+
Personalize your assistant's responses using variables that can be customized for each call. This allows you to:
28+
- Insert dynamic content like dates, times, and user information
29+
- Customize greetings and responses
30+
- Maintain context across conversations
31+
32+
### Call Analysis
33+
Get detailed insights into each conversation through:
34+
- Call summaries
35+
- Structured data extraction
36+
- Success evaluation metrics
37+
- Custom analysis rubrics
38+
39+
### Persistence Options
40+
Choose between:
41+
- **Persistent Assistants**: Reusable configurations stored via the `/assistant` endpoint
42+
- **Temporary Assistants**: One-time configurations specified when starting a call
43+
44+
## Prompting Best Practices
45+
46+
Effective prompt engineering is crucial for creating successful voice AI agents. Learn how to:
47+
- Structure prompts for voice interactions
48+
- Add personality and natural speech patterns
49+
- Handle errors gracefully
50+
- Improve response quality
51+
52+
<Card
53+
title="Voice AI Prompting Guide"
54+
icon="book"
55+
href="/prompting-guide"
56+
>
57+
Learn best practices for engineering voice AI prompts
58+
</Card>
1159

1260
## Advanced Concepts
1361

0 commit comments

Comments
 (0)