From b0dcde6f8b7b5f3ad61c7ce2d87c1c07e7210c4a Mon Sep 17 00:00:00 2001 From: skeptrune Date: Wed, 2 Apr 2025 22:18:04 -0700 Subject: [PATCH] feat(docs): add titles and slugs to various documentation files --- fern/assistants/assistant-hooks.mdx | 5 +++++ fern/calls/call-dynamic-transfers.mdx | 4 ++++ fern/calls/call-handling-with-vapi-and-twilio.mdx | 5 +++++ fern/calls/voicemail-detection.mdx | 5 +++++ fern/customization/custom-llm/tool-calling-integration.mdx | 4 ++++ fern/customization/custom-transcriber.mdx | 4 ++++ fern/fern.config.json | 2 +- fern/info-hierarchy.mdx | 4 ++-- fern/server-url/server-authentication.mdx | 5 +++++ fern/squads/silent-transfers.mdx | 4 ++++ 10 files changed, 39 insertions(+), 3 deletions(-) diff --git a/fern/assistants/assistant-hooks.mdx b/fern/assistants/assistant-hooks.mdx index 462073b8..2a50c513 100644 --- a/fern/assistants/assistant-hooks.mdx +++ b/fern/assistants/assistant-hooks.mdx @@ -1,3 +1,8 @@ +--- +title: Assistant Hooks +slug: assistants/assistant-hooks +--- + # Assistant Hooks Assistant hooks allow you to configure actions that will be performed when specific events occur during a call. Currently, hooks support the `call.ending` event, which triggers when a call is ending. diff --git a/fern/calls/call-dynamic-transfers.mdx b/fern/calls/call-dynamic-transfers.mdx index 84beccc8..324d1349 100644 --- a/fern/calls/call-dynamic-transfers.mdx +++ b/fern/calls/call-dynamic-transfers.mdx @@ -1,3 +1,7 @@ +--- +title: Dynamic Call Transfers +slug: calls/call-dynamic-transfers +--- ## Introduction to Transfer Destinations Transferring calls dynamically based on context is an essential feature for handling user interactions effectively. This guide walks you through creating a custom transfer tool, linking it to your assistant, and handling transfer requests with detailed examples. Whether the destination is a phone number, SIP, or another assistant, you'll learn how to configure it seamlessly. diff --git a/fern/calls/call-handling-with-vapi-and-twilio.mdx b/fern/calls/call-handling-with-vapi-and-twilio.mdx index 12bf06f5..275ff8dc 100644 --- a/fern/calls/call-handling-with-vapi-and-twilio.mdx +++ b/fern/calls/call-handling-with-vapi-and-twilio.mdx @@ -1,3 +1,8 @@ +--- +title: Call Handling with Vapi and Twilio +slug: calls/call-handling-with-vapi-and-twilio +--- + This document explains how to handle a scenario where a user is on hold while the system attempts to connect them to a specialist. If the specialist does not pick up within X seconds or if the call hits voicemail, we take an alternate action (like playing an announcement or scheduling an appointment). This solution integrates Vapi.ai for AI-driven conversations and Twilio for call bridging. ## Problem diff --git a/fern/calls/voicemail-detection.mdx b/fern/calls/voicemail-detection.mdx index 617a36a6..d1f562b2 100644 --- a/fern/calls/voicemail-detection.mdx +++ b/fern/calls/voicemail-detection.mdx @@ -1,3 +1,8 @@ +--- +title: Voicemail Detection +slug: calls/voicemail-detection +--- + Voicemail is basically a digital answering machine. When you can’t pick up, callers can leave a message so you don’t miss anything important. It’s especially handy if you’re in a meeting, driving, or just can’t get to the phone in time. ### **The Main Problem** diff --git a/fern/customization/custom-llm/tool-calling-integration.mdx b/fern/customization/custom-llm/tool-calling-integration.mdx index 096c6c87..4ec070e2 100644 --- a/fern/customization/custom-llm/tool-calling-integration.mdx +++ b/fern/customization/custom-llm/tool-calling-integration.mdx @@ -1,3 +1,7 @@ +--- +title: Custom LLM Tool Calling Integration +slug: customization/tool-calling-integration +--- ## What Is a Custom LLM and Why Use It? A **Custom LLM** is more than just a text generator—it’s a conversational assistant that can call external functions, trigger processes, and handle special logic, all while chatting with your users. Think of it as your smart helper that not only answers questions but also takes actions. diff --git a/fern/customization/custom-transcriber.mdx b/fern/customization/custom-transcriber.mdx index d6912af3..32fe8ff5 100644 --- a/fern/customization/custom-transcriber.mdx +++ b/fern/customization/custom-transcriber.mdx @@ -1,3 +1,7 @@ +--- +title: Custom Transcriber +slug: customization/custom-transcriber +--- ## Introduction Vapi supports several transcription providers, but sometimes you may need to use your own transcription service. This guide shows you how to integrate Deepgram as your custom transcriber. The solution streams raw stereo PCM audio (16‑bit) from Vapi via WebSocket to your server, which then forwards the audio to Deepgram. Deepgram returns real‑time partial and final transcripts that are processed (including channel detection) and sent back to Vapi. diff --git a/fern/fern.config.json b/fern/fern.config.json index 60630e2e..f284114e 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "vapi", - "version": "0.57.2" + "version": "0.57.15" } \ No newline at end of file diff --git a/fern/info-hierarchy.mdx b/fern/info-hierarchy.mdx index e899cabc..c6657e12 100644 --- a/fern/info-hierarchy.mdx +++ b/fern/info-hierarchy.mdx @@ -51,12 +51,12 @@ * Getting Started * Build * Assistants - * Workflows <-- + * Workflows <-- * Tools * Knowledge Base * Squads * Test - * Voice Testing <-- + * Voice Testing <-- * Deploy * Phone Numbers * Calls diff --git a/fern/server-url/server-authentication.mdx b/fern/server-url/server-authentication.mdx index f6f37ec6..b43e9a34 100644 --- a/fern/server-url/server-authentication.mdx +++ b/fern/server-url/server-authentication.mdx @@ -1,3 +1,8 @@ +--- +title: Server Authentication +slug: server-url/server-authentication +--- + # Server Authentication When configuring webhooks for your assistant, you can authenticate your server endpoints using either a secret token, custom headers, or OAuth2. This ensures that only authorized requests from Vapi are processed by your server. diff --git a/fern/squads/silent-transfers.mdx b/fern/squads/silent-transfers.mdx index 31cb7a14..6d28c493 100644 --- a/fern/squads/silent-transfers.mdx +++ b/fern/squads/silent-transfers.mdx @@ -1,3 +1,7 @@ +--- +title: Silent Transfers +slug: squads/silent-transfers +--- - **The Problem**: In traditional AI call flows, when transferring from one agent to another, announcing the transfer verbally can confuse or annoy callers and disrupt the conversation's flow. - **The Solution**: Silent transfers keep the call experience _uninterrupted_, so the user doesn’t know multiple assistants are involved. The conversation flows more naturally, boosting customer satisfaction.