Dom/gemini system prompt switching (#1260)
* Updated example to use Gemini * Fixed typo * Based on feedback, made the gemini file something that can be called separately * Updated the readme * Updated the readme * Changed example to use gemini 2.0 flash lite * This works * Improvement * I think this works * Updated the code to use the correct prompt broken down into smaller pieces * Added a few more things to detect in the prompt * Fixed import ordering * Updated prompt for non gemini bot to look for more voicemail examples, plus added logic to detect if we're doing dialin or not to avoid a non-fatal dialin related error * moved terminate call to handlers class * Simplified logic for dialin * Forgot to use the same logic for the openai bot * Starting to add logic for native audio input for flash lite * Fixed logic * Fixed some code based on suggestions
This commit is contained in:
@@ -106,12 +106,12 @@ curl -X POST "http://localhost:7860/daily_start_bot" \
|
|||||||
-d '{"dialoutNumber": "+18057145330", "detectVoicemail": true}'
|
-d '{"dialoutNumber": "+18057145330", "detectVoicemail": true}'
|
||||||
```
|
```
|
||||||
|
|
||||||
### New! Using Gemini with Daily
|
### New! Using Gemini 2.0 Flash Lite with Daily
|
||||||
|
|
||||||
We have introduced a new example file that uses Gemini. You can find the code within bot_daily_gemini.py.
|
We have introduced support for Google's Gemini 2.0 Flash Lite model in this example. This lightweight model offers faster response times and reduced costs while maintaining good conversational capabilities.
|
||||||
If you want to spin up a Gemini-based bot for this demo, instead of an OpenAI-based bot, call the same properties above but on the `daily_gemini_start_bot` endpoint instead.
|
|
||||||
|
|
||||||
For example:
|
**Quick Start**
|
||||||
|
To use the Gemini-based bot instead of OpenAI:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl -X POST "http://localhost:7860/daily_gemini_start_bot" \ py pipecat
|
curl -X POST "http://localhost:7860/daily_gemini_start_bot" \ py pipecat
|
||||||
@@ -119,7 +119,27 @@ curl -X POST "http://localhost:7860/daily_gemini_start_bot" \
|
|||||||
-d '{"detectVoicemail": true}'
|
-d '{"detectVoicemail": true}'
|
||||||
```
|
```
|
||||||
|
|
||||||
Any request body properties supported by `/daily_start_bot` (such as "detectVoicemail", "dialoutnumber", etc) can also be passed to `/daily_gemini_start_bot`. The only difference is that calling the Gemini endpoint will start a Gemini bot session.
|
All request body parameters supported by /daily_start_bot (such as detectVoicemail, dialoutNumber, etc.) are also compatible with /daily_gemini_start_bot.
|
||||||
|
|
||||||
|
This example uses context switching to help steer the bot in the right direction. As Flash Lite is a smaller model, breaking the prompt down into smaller piece helps to improve the bot's accuracy.
|
||||||
|
|
||||||
|
For example, instead of giving one large prompt like:
|
||||||
|
|
||||||
|
```python
|
||||||
|
system_instruction="""You are a chatbot that needs to detect if you're talking to a voicemail system or human, then either leave a message or have a conversation. If it's voicemail, say "Hello, this is a message..." and hang up. If it's a human, introduce yourself and be helpful until they say goodbye."""
|
||||||
|
```
|
||||||
|
|
||||||
|
We break it into stages:
|
||||||
|
|
||||||
|
First prompt focuses only on detection: "Determine if this is voicemail or human"
|
||||||
|
After detection, we switch to a new context: either "Leave this specific voicemail message" or "Have a conversation with the human".
|
||||||
|
|
||||||
|
**Implementation Details**
|
||||||
|
The implementation is available in bot_daily_gemini.py and features:
|
||||||
|
|
||||||
|
- Staged prompting approach: Breaking down complex tasks into smaller, more focused prompts to improve the lightweight model's performance
|
||||||
|
- Dynamic context switching: The bot can change its behavior in real-time based on what it detects (voicemail vs. human caller)
|
||||||
|
- Function-based architecture: Uses function calling to trigger context switches and call termination
|
||||||
|
|
||||||
### More information
|
### More information
|
||||||
|
|
||||||
|
|||||||
@@ -49,7 +49,11 @@ async def main(
|
|||||||
# If you are handling this via Twilio, Telnyx, set this to None
|
# If you are handling this via Twilio, Telnyx, set this to None
|
||||||
# and handle call-forwarding when on_dialin_ready fires.
|
# and handle call-forwarding when on_dialin_ready fires.
|
||||||
|
|
||||||
dialin_settings = DailyDialinSettings(call_id=callId, call_domain=callDomain)
|
# We don't want to specify dial-in settings if we're not dialing in
|
||||||
|
dialin_settings = None
|
||||||
|
if callId and callDomain:
|
||||||
|
dialin_settings = DailyDialinSettings(call_id=callId, call_domain=callDomain)
|
||||||
|
|
||||||
transport = DailyTransport(
|
transport = DailyTransport(
|
||||||
room_url,
|
room_url,
|
||||||
token,
|
token,
|
||||||
@@ -96,6 +100,13 @@ async def main(
|
|||||||
- **"Please leave a message after the beep."**
|
- **"Please leave a message after the beep."**
|
||||||
- **"No one is available to take your call."**
|
- **"No one is available to take your call."**
|
||||||
- **"Record your message after the tone."**
|
- **"Record your message after the tone."**
|
||||||
|
- **"Please leave a message after the beep"**
|
||||||
|
- **"You have reached voicemail for..."**
|
||||||
|
- **"You have reached [phone number]"**
|
||||||
|
- **"[phone number] is unavailable"**
|
||||||
|
- **"The person you are trying to reach..."**
|
||||||
|
- **"The number you have dialed..."**
|
||||||
|
- **"Your call has been forwarded to an automated voice messaging system"**
|
||||||
- **Any phrase that suggests an answering machine or voicemail.**
|
- **Any phrase that suggests an answering machine or voicemail.**
|
||||||
- **ASSUME IT IS A VOICEMAIL. DO NOT WAIT FOR MORE CONFIRMATION.**
|
- **ASSUME IT IS A VOICEMAIL. DO NOT WAIT FOR MORE CONFIRMATION.**
|
||||||
- **IF THE CALL SAYS "PLEASE LEAVE A MESSAGE AFTER THE BEEP", WAIT FOR THE BEEP BEFORE LEAVING A MESSAGE.**
|
- **IF THE CALL SAYS "PLEASE LEAVE A MESSAGE AFTER THE BEEP", WAIT FOR THE BEEP BEFORE LEAVING A MESSAGE.**
|
||||||
|
|||||||
@@ -7,17 +7,29 @@ import argparse
|
|||||||
import asyncio
|
import asyncio
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
from dataclasses import dataclass
|
||||||
from typing import Optional
|
from typing import Optional
|
||||||
|
|
||||||
|
import google.ai.generativelanguage as glm
|
||||||
from dotenv import load_dotenv
|
from dotenv import load_dotenv
|
||||||
from loguru import logger
|
from loguru import logger
|
||||||
|
|
||||||
from pipecat.audio.vad.silero import SileroVADAnalyzer
|
from pipecat.audio.vad.silero import SileroVADAnalyzer
|
||||||
from pipecat.frames.frames import EndTaskFrame
|
from pipecat.frames.frames import (
|
||||||
|
BotStoppedSpeakingFrame,
|
||||||
|
EndTaskFrame,
|
||||||
|
Frame,
|
||||||
|
InputAudioRawFrame,
|
||||||
|
SystemFrame,
|
||||||
|
TranscriptionFrame,
|
||||||
|
UserStartedSpeakingFrame,
|
||||||
|
UserStoppedSpeakingFrame,
|
||||||
|
)
|
||||||
from pipecat.pipeline.pipeline import Pipeline
|
from pipecat.pipeline.pipeline import Pipeline
|
||||||
from pipecat.pipeline.runner import PipelineRunner
|
from pipecat.pipeline.runner import PipelineRunner
|
||||||
from pipecat.pipeline.task import PipelineParams, PipelineTask
|
from pipecat.pipeline.task import PipelineParams, PipelineTask
|
||||||
from pipecat.processors.frame_processor import FrameDirection
|
from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContextFrame
|
||||||
|
from pipecat.processors.frame_processor import FrameDirection, FrameProcessor
|
||||||
from pipecat.services.ai_services import LLMService
|
from pipecat.services.ai_services import LLMService
|
||||||
from pipecat.services.elevenlabs import ElevenLabsTTSService
|
from pipecat.services.elevenlabs import ElevenLabsTTSService
|
||||||
from pipecat.services.google import GoogleLLMContext, GoogleLLMService
|
from pipecat.services.google import GoogleLLMContext, GoogleLLMService
|
||||||
@@ -33,10 +45,119 @@ daily_api_key = os.getenv("DAILY_API_KEY", "")
|
|||||||
daily_api_url = os.getenv("DAILY_API_URL", "https://api.daily.co/v1")
|
daily_api_url = os.getenv("DAILY_API_URL", "https://api.daily.co/v1")
|
||||||
|
|
||||||
|
|
||||||
|
class UserAudioCollector(FrameProcessor):
|
||||||
|
"""This FrameProcessor collects audio frames in a buffer, then adds them to the
|
||||||
|
LLM context when the user stops speaking.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, context, user_context_aggregator):
|
||||||
|
super().__init__()
|
||||||
|
self._context = context
|
||||||
|
self._user_context_aggregator = user_context_aggregator
|
||||||
|
self._audio_frames = []
|
||||||
|
self._start_secs = 0.2 # this should match VAD start_secs (hardcoding for now)
|
||||||
|
self._user_speaking = False
|
||||||
|
|
||||||
|
async def process_frame(self, frame, direction):
|
||||||
|
await super().process_frame(frame, direction)
|
||||||
|
|
||||||
|
if isinstance(frame, TranscriptionFrame):
|
||||||
|
# We could gracefully handle both audio input and text/transcription input ...
|
||||||
|
# but let's leave that as an exercise to the reader. :-)
|
||||||
|
return
|
||||||
|
if isinstance(frame, UserStartedSpeakingFrame):
|
||||||
|
self._user_speaking = True
|
||||||
|
elif isinstance(frame, UserStoppedSpeakingFrame):
|
||||||
|
self._user_speaking = False
|
||||||
|
self._context.add_audio_frames_message(audio_frames=self._audio_frames)
|
||||||
|
await self._user_context_aggregator.push_frame(
|
||||||
|
self._user_context_aggregator.get_context_frame()
|
||||||
|
)
|
||||||
|
elif isinstance(frame, InputAudioRawFrame):
|
||||||
|
if self._user_speaking:
|
||||||
|
self._audio_frames.append(frame)
|
||||||
|
else:
|
||||||
|
# Append the audio frame to our buffer. Treat the buffer as a ring buffer, dropping the oldest
|
||||||
|
# frames as necessary. Assume all audio frames have the same duration.
|
||||||
|
self._audio_frames.append(frame)
|
||||||
|
frame_duration = len(frame.audio) / 16 * frame.num_channels / frame.sample_rate
|
||||||
|
buffer_duration = frame_duration * len(self._audio_frames)
|
||||||
|
while buffer_duration > self._start_secs:
|
||||||
|
self._audio_frames.pop(0)
|
||||||
|
buffer_duration -= frame_duration
|
||||||
|
|
||||||
|
await self.push_frame(frame, direction)
|
||||||
|
|
||||||
|
|
||||||
|
class ContextSwitcher:
|
||||||
|
def __init__(self, llm, context_aggregator):
|
||||||
|
self._llm = llm
|
||||||
|
self._context_aggregator = context_aggregator
|
||||||
|
|
||||||
|
async def switch_context(self, system_instruction):
|
||||||
|
"""Switch the context to a new system instruction based on what the bot hears."""
|
||||||
|
# Create messages with updated system instruction
|
||||||
|
messages = [
|
||||||
|
{
|
||||||
|
"role": "system",
|
||||||
|
"content": system_instruction,
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
# Update context with new messages
|
||||||
|
self._context_aggregator.set_messages(messages)
|
||||||
|
# Get the context frame with the updated messages
|
||||||
|
context_frame = self._context_aggregator.get_context_frame()
|
||||||
|
# Trigger LLM response by pushing a context frame
|
||||||
|
await self._llm.push_frame(context_frame)
|
||||||
|
|
||||||
|
|
||||||
|
class FunctionHandlers:
|
||||||
|
def __init__(self, context_switcher):
|
||||||
|
self.context_switcher = context_switcher
|
||||||
|
|
||||||
|
async def voicemail_response(
|
||||||
|
self, function_name, tool_call_id, args, llm, context, result_callback
|
||||||
|
):
|
||||||
|
"""Function the bot can call to leave a voicemail message."""
|
||||||
|
message = """You are Chatbot leaving a voicemail message. Say EXACTLY this message and nothing else:
|
||||||
|
|
||||||
|
"Hello, this is a message for Pipecat example user. This is Chatbot. Please call back on 123-456-7891. Thank you."
|
||||||
|
|
||||||
|
After saying this message, call the terminate_call function."""
|
||||||
|
|
||||||
|
await self.context_switcher.switch_context(system_instruction=message)
|
||||||
|
|
||||||
|
await result_callback("Leaving a voicemail message")
|
||||||
|
|
||||||
|
async def human_conversation(
|
||||||
|
self, function_name, tool_call_id, args, llm, context, result_callback
|
||||||
|
):
|
||||||
|
"""Function the bot can when it detects it's talking to a human."""
|
||||||
|
message = """You are Chatbot talking to a human. Be friendly and helpful.
|
||||||
|
|
||||||
|
Start with: "Hello! I'm a friendly chatbot. How can I help you today?"
|
||||||
|
|
||||||
|
Keep your responses brief and to the point. Listen to what the person says.
|
||||||
|
|
||||||
|
When the person indicates they're done with the conversation by saying something like:
|
||||||
|
- "Goodbye"
|
||||||
|
- "That's all"
|
||||||
|
- "I'm done"
|
||||||
|
- "Thank you, that's all I needed"
|
||||||
|
|
||||||
|
THEN say: "Thank you for chatting. Goodbye!" and call the terminate_call function."""
|
||||||
|
|
||||||
|
await self.context_switcher.switch_context(system_instruction=message)
|
||||||
|
|
||||||
|
await result_callback("Talking to the customer")
|
||||||
|
|
||||||
|
|
||||||
async def terminate_call(
|
async def terminate_call(
|
||||||
function_name, tool_call_id, args, llm: LLMService, context, result_callback
|
function_name, tool_call_id, args, llm: LLMService, context, result_callback
|
||||||
):
|
):
|
||||||
"""Function the bot can call to terminate the call upon completion of a voicemail message."""
|
"""Function the bot can call to terminate the call upon completion of the call."""
|
||||||
|
|
||||||
await llm.queue_frame(EndTaskFrame(), FrameDirection.UPSTREAM)
|
await llm.queue_frame(EndTaskFrame(), FrameDirection.UPSTREAM)
|
||||||
|
|
||||||
|
|
||||||
@@ -51,7 +172,12 @@ async def main(
|
|||||||
# dialin_settings are only needed if Daily's SIP URI is used
|
# dialin_settings are only needed if Daily's SIP URI is used
|
||||||
# If you are handling this via Twilio, Telnyx, set this to None
|
# If you are handling this via Twilio, Telnyx, set this to None
|
||||||
# and handle call-forwarding when on_dialin_ready fires.
|
# and handle call-forwarding when on_dialin_ready fires.
|
||||||
dialin_settings = DailyDialinSettings(call_id=callId, call_domain=callDomain)
|
|
||||||
|
# We don't want to specify dial-in settings if we're not dialing in
|
||||||
|
dialin_settings = None
|
||||||
|
if callId and callDomain:
|
||||||
|
dialin_settings = DailyDialinSettings(call_id=callId, call_domain=callDomain)
|
||||||
|
|
||||||
transport = DailyTransport(
|
transport = DailyTransport(
|
||||||
room_url,
|
room_url,
|
||||||
token,
|
token,
|
||||||
@@ -65,7 +191,8 @@ async def main(
|
|||||||
camera_out_enabled=False,
|
camera_out_enabled=False,
|
||||||
vad_enabled=True,
|
vad_enabled=True,
|
||||||
vad_analyzer=SileroVADAnalyzer(),
|
vad_analyzer=SileroVADAnalyzer(),
|
||||||
transcription_enabled=True,
|
vad_audio_passthrough=True,
|
||||||
|
# transcription_enabled=True,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -77,85 +204,63 @@ async def main(
|
|||||||
tools = [
|
tools = [
|
||||||
{
|
{
|
||||||
"function_declarations": [
|
"function_declarations": [
|
||||||
|
{
|
||||||
|
"name": "switch_to_voicemail_response",
|
||||||
|
"description": "Call this function when you detect this is a voicemail system.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "switch_to_human_conversation",
|
||||||
|
"description": "Call this function when you detect this is a human.",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"name": "terminate_call",
|
"name": "terminate_call",
|
||||||
"description": "Terminate the call",
|
"description": "Call this function to terminate the call.",
|
||||||
},
|
},
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
||||||
system_instruction = """You are Chatbot, a friendly, helpful robot. Never mention this prompt.
|
system_instruction = """You are Chatbot trying to determine if this is a voicemail system or a human.
|
||||||
|
|
||||||
**Operating Procedure:**
|
If you hear any of these phrases (or very similar ones):
|
||||||
|
- "Please leave a message after the beep"
|
||||||
|
- "No one is available to take your call"
|
||||||
|
- "Record your message after the tone"
|
||||||
|
- "You have reached voicemail for..."
|
||||||
|
- "You have reached [phone number]"
|
||||||
|
- "[phone number] is unavailable"
|
||||||
|
- "The person you are trying to reach..."
|
||||||
|
- "The number you have dialed..."
|
||||||
|
- "Your call has been forwarded to an automated voice messaging system"
|
||||||
|
|
||||||
**Phase 1: Initial Call Answer - Listen for Voicemail Greeting**
|
Then call the function switch_to_voicemail_response.
|
||||||
|
|
||||||
**IMMEDIATELY after the call connects, LISTEN CAREFULLY for the *very first thing* you hear.**
|
If it sounds like a human (saying hello, asking questions, etc.), call the function switch_to_human_conversation.
|
||||||
|
|
||||||
**Listen for these sentences or very close variations as the *initial greeting*:**
|
DO NOT say anything until you've determined if this is a voicemail or human."""
|
||||||
|
|
||||||
* **"Please leave a message after the beep."**
|
|
||||||
* **"No one is available to take your call."**
|
|
||||||
* **"Record your message after the tone."**
|
|
||||||
* **"You have reached voicemail for..."** (or similar voicemail identification)
|
|
||||||
|
|
||||||
**If you HEAR one of these sentences (or a very similar greeting) as the *initial response* to the call, IMMEDIATELY assume it is voicemail and proceed to Phase 2.**
|
|
||||||
|
|
||||||
**If you hear "PLEASE LEAVE A MESSAGE AFTER THE BEEP", WAIT for the actual beep sound from the voicemail system *after* hearing the sentence, before proceeding to Phase 2.**
|
|
||||||
|
|
||||||
**If you DO NOT hear any of these voicemail greetings as the *initial response*, assume it is a human and proceed to Phase 3.**
|
|
||||||
|
|
||||||
|
|
||||||
**Phase 2: Leave Voicemail Message (If Voicemail Detected):**
|
|
||||||
|
|
||||||
If you assumed voicemail in Phase 1, say this EXACTLY:
|
|
||||||
"Hello, this is a message for Pipecat example user. This is Chatbot. Please call back on 123-456-7891. Thank you."
|
|
||||||
|
|
||||||
**Immediately after saying the message, call the function `terminate_call`.**
|
|
||||||
**DO NOT SAY ANYTHING ELSE. SILENCE IS REQUIRED AFTER `terminate_call`.**
|
|
||||||
|
|
||||||
|
|
||||||
**Phase 3: Human Interaction (If No Voicemail Greeting Detected in Phase 1):**
|
|
||||||
|
|
||||||
If you did not detect a voicemail greeting in Phase 1 and a human answers, say:
|
|
||||||
"Oh, hello! I'm a friendly chatbot. Is there anything I can help you with?"
|
|
||||||
|
|
||||||
Keep your responses **short and helpful.**
|
|
||||||
|
|
||||||
If the human is finished, say:
|
|
||||||
"Okay, thank you! Have a great day!"
|
|
||||||
|
|
||||||
**Then, immediately call the function `terminate_call`.**
|
|
||||||
|
|
||||||
|
|
||||||
**VERY IMPORTANT RULES - DO NOT DO THESE THINGS:**
|
|
||||||
|
|
||||||
* **DO NOT SAY "Please leave a message after the beep."**
|
|
||||||
* **DO NOT SAY "No one is available to take your call."**
|
|
||||||
* **DO NOT SAY "Record your message after the tone."**
|
|
||||||
* **DO NOT SAY ANY voicemail greeting yourself.**
|
|
||||||
* **Only check for voicemail greetings in Phase 1, *immediately after the call connects*.**
|
|
||||||
* **After voicemail or human interaction, ALWAYS call `terminate_call` immediately.**
|
|
||||||
* **Do not speak after calling `terminate_call`.**
|
|
||||||
* Your speech will be audio, so use simple language without special characters.
|
|
||||||
"""
|
|
||||||
|
|
||||||
llm = GoogleLLMService(
|
llm = GoogleLLMService(
|
||||||
model="models/gemini-2.0-flash-exp",
|
model="models/gemini-2.0-flash-lite-preview-02-05",
|
||||||
api_key=os.getenv("GOOGLE_API_KEY"),
|
api_key=os.getenv("GOOGLE_API_KEY"),
|
||||||
system_instruction=system_instruction,
|
system_instruction=system_instruction,
|
||||||
tools=tools,
|
tools=tools,
|
||||||
)
|
)
|
||||||
llm.register_function("terminate_call", terminate_call)
|
|
||||||
|
|
||||||
context = GoogleLLMContext()
|
context = GoogleLLMContext()
|
||||||
|
|
||||||
context_aggregator = llm.create_context_aggregator(context)
|
context_aggregator = llm.create_context_aggregator(context)
|
||||||
|
audio_collector = UserAudioCollector(context, context_aggregator.user())
|
||||||
|
|
||||||
|
context_switcher = ContextSwitcher(llm, context_aggregator.user())
|
||||||
|
handlers = FunctionHandlers(context_switcher)
|
||||||
|
|
||||||
|
llm.register_function("switch_to_voicemail_response", handlers.voicemail_response)
|
||||||
|
llm.register_function("switch_to_human_conversation", handlers.human_conversation)
|
||||||
|
llm.register_function("terminate_call", terminate_call)
|
||||||
|
|
||||||
pipeline = Pipeline(
|
pipeline = Pipeline(
|
||||||
[
|
[
|
||||||
transport.input(), # Transport user input
|
transport.input(), # Transport user input
|
||||||
|
audio_collector, # Collect audio frames
|
||||||
context_aggregator.user(), # User responses
|
context_aggregator.user(), # User responses
|
||||||
llm, # LLM
|
llm, # LLM
|
||||||
tts, # TTS
|
tts, # TTS
|
||||||
|
|||||||
Reference in New Issue
Block a user