Simple voice agent example using SmallWebRTCTransport.
This commit is contained in:
34
examples/aiortc/voice-agent/README.rst
Normal file
34
examples/aiortc/voice-agent/README.rst
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# Video transform
|
||||||
|
|
||||||
|
A Pipecat example demonstrating the simplest way to create a voice agent with SmallWebRTCTransport.
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
### First, start the bot server:
|
||||||
|
|
||||||
|
1. Create and activate a virtual environment:
|
||||||
|
```bash
|
||||||
|
python3 -m venv venv
|
||||||
|
source venv/bin/activate # On Windows: venv\Scripts\activate
|
||||||
|
```
|
||||||
|
2. Install requirements:
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
3. Copy env.example to .env and configure:
|
||||||
|
- Add your API keys
|
||||||
|
4. Start the server:
|
||||||
|
```bash
|
||||||
|
python server.py
|
||||||
|
```
|
||||||
|
|
||||||
|
### Next, connect using the client app:
|
||||||
|
|
||||||
|
Visit http://localhost:7860 in your browser.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- Python 3.10+
|
||||||
|
- Node.js 16+ (for JavaScript)
|
||||||
|
- Google API key
|
||||||
|
- Modern web browser with WebRTC support
|
||||||
102
examples/aiortc/voice-agent/aiortc_bot.py
Normal file
102
examples/aiortc/voice-agent/aiortc_bot.py
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
#
|
||||||
|
# Copyright (c) 2025, Daily
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: BSD 2-Clause License
|
||||||
|
#
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from dotenv import load_dotenv
|
||||||
|
from loguru import logger
|
||||||
|
|
||||||
|
from pipecat.audio.vad.silero import SileroVADAnalyzer
|
||||||
|
from pipecat.pipeline.pipeline import Pipeline
|
||||||
|
from pipecat.pipeline.runner import PipelineRunner
|
||||||
|
from pipecat.pipeline.task import PipelineParams, PipelineTask
|
||||||
|
from pipecat.processors.aggregators.openai_llm_context import OpenAILLMContext
|
||||||
|
from pipecat.services.gemini_multimodal_live import GeminiMultimodalLiveLLMService
|
||||||
|
from pipecat.transports.base_transport import TransportParams
|
||||||
|
from pipecat.transports.network.small_webrtc import SmallWebRTCTransport
|
||||||
|
|
||||||
|
load_dotenv(override=True)
|
||||||
|
|
||||||
|
logger.remove(0)
|
||||||
|
logger.add(sys.stderr, level="DEBUG")
|
||||||
|
|
||||||
|
|
||||||
|
SYSTEM_INSTRUCTION = f"""
|
||||||
|
"You are Gemini Chatbot, a friendly, helpful robot.
|
||||||
|
|
||||||
|
Your goal is to demonstrate your capabilities in a succinct way.
|
||||||
|
|
||||||
|
Your output will be converted to audio so don't include special characters in your answers.
|
||||||
|
|
||||||
|
Respond to what the user said in a creative and helpful way. Keep your responses brief. One or two sentences at most.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
async def run_bot(webrtc_connection):
|
||||||
|
pipecat_transport = SmallWebRTCTransport(
|
||||||
|
webrtc_connection=webrtc_connection,
|
||||||
|
params=TransportParams(
|
||||||
|
audio_in_enabled=True,
|
||||||
|
audio_out_enabled=True,
|
||||||
|
vad_enabled=True,
|
||||||
|
vad_analyzer=SileroVADAnalyzer(),
|
||||||
|
vad_audio_passthrough=True,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
llm = GeminiMultimodalLiveLLMService(
|
||||||
|
api_key=os.getenv("GOOGLE_API_KEY"),
|
||||||
|
voice_id="Puck", # Aoede, Charon, Fenrir, Kore, Puck
|
||||||
|
transcribe_user_audio=True,
|
||||||
|
transcribe_model_audio=True,
|
||||||
|
system_instruction=SYSTEM_INSTRUCTION,
|
||||||
|
)
|
||||||
|
|
||||||
|
context = OpenAILLMContext(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"role": "user",
|
||||||
|
"content": "Start by greeting the user warmly and introducing yourself.",
|
||||||
|
}
|
||||||
|
],
|
||||||
|
)
|
||||||
|
context_aggregator = llm.create_context_aggregator(context)
|
||||||
|
|
||||||
|
pipeline = Pipeline(
|
||||||
|
[
|
||||||
|
pipecat_transport.input(),
|
||||||
|
context_aggregator.user(),
|
||||||
|
llm, # LLM
|
||||||
|
pipecat_transport.output(),
|
||||||
|
context_aggregator.assistant(),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
task = PipelineTask(
|
||||||
|
pipeline,
|
||||||
|
params=PipelineParams(
|
||||||
|
allow_interruptions=True,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
@pipecat_transport.event_handler("on_client_connected")
|
||||||
|
async def on_client_connected(transport, client):
|
||||||
|
logger.info("Pipecat Client connected")
|
||||||
|
# Kick off the conversation.
|
||||||
|
await task.queue_frames([context_aggregator.user().get_context_frame()])
|
||||||
|
|
||||||
|
@pipecat_transport.event_handler("on_client_disconnected")
|
||||||
|
async def on_client_disconnected(transport, client):
|
||||||
|
logger.info("Pipecat Client disconnected")
|
||||||
|
|
||||||
|
@pipecat_transport.event_handler("on_client_closed")
|
||||||
|
async def on_client_closed(transport, client):
|
||||||
|
logger.info("Pipecat Client closed")
|
||||||
|
await task.cancel()
|
||||||
|
|
||||||
|
runner = PipelineRunner(handle_sigint=False)
|
||||||
|
|
||||||
|
await runner.run(task)
|
||||||
1
examples/aiortc/voice-agent/env.example
Normal file
1
examples/aiortc/voice-agent/env.example
Normal file
@@ -0,0 +1 @@
|
|||||||
|
GOOGLE_API_KEY=
|
||||||
99
examples/aiortc/voice-agent/index.html
Normal file
99
examples/aiortc/voice-agent/index.html
Normal file
@@ -0,0 +1,99 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>WebRTC Voice Agent</title>
|
||||||
|
<style>
|
||||||
|
body { font-family: Arial, sans-serif; text-align: center; margin-top: 50px; }
|
||||||
|
#status { font-size: 20px; margin: 20px; }
|
||||||
|
button { padding: 10px 20px; font-size: 16px; }
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>WebRTC Voice Agent</h1>
|
||||||
|
<p id="status">Disconnected</p>
|
||||||
|
<button id="connect-btn">Connect</button>
|
||||||
|
<audio id="audio-el" autoplay></audio>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
const statusEl = document.getElementById("status")
|
||||||
|
const buttonEl = document.getElementById("connect-btn")
|
||||||
|
const audioEl = document.getElementById("audio-el")
|
||||||
|
|
||||||
|
let connected = false
|
||||||
|
let peerConnection = null
|
||||||
|
|
||||||
|
const waitForIceGatheringComplete = async (pc) => {
|
||||||
|
if (pc.iceGatheringState === 'complete') return;
|
||||||
|
return new Promise((resolve) => {
|
||||||
|
const checkState = () => {
|
||||||
|
if (pc.iceGatheringState === 'complete') {
|
||||||
|
pc.removeEventListener('icegatheringstatechange', checkState);
|
||||||
|
resolve();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
pc.addEventListener('icegatheringstatechange', checkState);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const createSmallWebRTCConnection = async (audioTrack) => {
|
||||||
|
const pc = new RTCPeerConnection()
|
||||||
|
pc.ontrack = e => audioEl.srcObject = e.streams[0]
|
||||||
|
pc.addTransceiver(audioTrack, { direction: 'sendrecv' })
|
||||||
|
await pc.setLocalDescription(await pc.createOffer())
|
||||||
|
await waitForIceGatheringComplete(pc)
|
||||||
|
const offer = pc.localDescription
|
||||||
|
const response = await fetch('/api/offer', {
|
||||||
|
body: JSON.stringify({ sdp: offer.sdp, type: offer.type}),
|
||||||
|
headers: { 'Content-Type': 'application/json' },
|
||||||
|
method: 'POST',
|
||||||
|
});
|
||||||
|
const answer = await response.json()
|
||||||
|
await pc.setRemoteDescription(answer)
|
||||||
|
return pc
|
||||||
|
}
|
||||||
|
|
||||||
|
const connect = async () => {
|
||||||
|
const audioStream = await navigator.mediaDevices.getUserMedia({audio: true})
|
||||||
|
peerConnection= await createSmallWebRTCConnection(audioStream.getAudioTracks()[0])
|
||||||
|
peerConnection.onconnectionstatechange = () => {
|
||||||
|
let connectionState = peerConnection?.connectionState
|
||||||
|
statusEl.textContent = connectionState
|
||||||
|
if (connectionState === 'connected') {
|
||||||
|
_onConnected()
|
||||||
|
} else if (connectionState === 'disconnected') {
|
||||||
|
_onDisconnected()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const _onConnected = () => {
|
||||||
|
buttonEl.textContent = "Disconnect"
|
||||||
|
connected = true
|
||||||
|
}
|
||||||
|
|
||||||
|
const _onDisconnected = () => {
|
||||||
|
buttonEl.textContent = "Connect"
|
||||||
|
connected = false
|
||||||
|
}
|
||||||
|
|
||||||
|
const disconnect = () => {
|
||||||
|
if (!peerConnection) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
peerConnection.close()
|
||||||
|
peerConnection = null
|
||||||
|
_onDisconnected()
|
||||||
|
}
|
||||||
|
|
||||||
|
buttonEl.addEventListener("click", async () => {
|
||||||
|
if (!connected) {
|
||||||
|
await connect()
|
||||||
|
} else {
|
||||||
|
disconnect()
|
||||||
|
}
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
5
examples/aiortc/voice-agent/requirements.txt
Normal file
5
examples/aiortc/voice-agent/requirements.txt
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
python-dotenv
|
||||||
|
fastapi[all]
|
||||||
|
uvicorn
|
||||||
|
aiortc
|
||||||
|
pipecat-ai[google,silero]
|
||||||
68
examples/aiortc/voice-agent/server.py
Normal file
68
examples/aiortc/voice-agent/server.py
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
import argparse
|
||||||
|
import asyncio
|
||||||
|
import logging
|
||||||
|
from contextlib import asynccontextmanager
|
||||||
|
|
||||||
|
import uvicorn
|
||||||
|
from aiortc_bot import run_bot
|
||||||
|
from dotenv import load_dotenv
|
||||||
|
from fastapi import BackgroundTasks, FastAPI
|
||||||
|
from fastapi.responses import FileResponse
|
||||||
|
|
||||||
|
from pipecat.transports.network.webrtc_connection import SmallWebRTCConnection
|
||||||
|
|
||||||
|
# Load environment variables
|
||||||
|
load_dotenv(override=True)
|
||||||
|
|
||||||
|
logger = logging.getLogger("pc")
|
||||||
|
|
||||||
|
app = FastAPI()
|
||||||
|
|
||||||
|
pcs = set()
|
||||||
|
|
||||||
|
|
||||||
|
@app.post("/api/offer")
|
||||||
|
async def offer(request: dict, background_tasks: BackgroundTasks):
|
||||||
|
pipecat_connection = SmallWebRTCConnection()
|
||||||
|
await pipecat_connection.initialize(sdp=request["sdp"], type=request["type"])
|
||||||
|
|
||||||
|
pcs.add(pipecat_connection)
|
||||||
|
|
||||||
|
@pipecat_connection.on("closed")
|
||||||
|
async def handle_disconnected():
|
||||||
|
logger.info("Discarding the peer connection.")
|
||||||
|
pcs.discard(pipecat_connection)
|
||||||
|
|
||||||
|
background_tasks.add_task(run_bot, pipecat_connection)
|
||||||
|
|
||||||
|
return pipecat_connection.get_answer()
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/")
|
||||||
|
async def serve_index():
|
||||||
|
return FileResponse("index.html")
|
||||||
|
|
||||||
|
|
||||||
|
@asynccontextmanager
|
||||||
|
async def lifespan(app: FastAPI):
|
||||||
|
yield # Run app
|
||||||
|
coros = [pc.close() for pc in pcs]
|
||||||
|
await asyncio.gather(*coros)
|
||||||
|
pcs.clear()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
parser = argparse.ArgumentParser(description="WebRTC demo")
|
||||||
|
parser.add_argument("--host", default="0.0.0.0", help="Host for HTTP server (default: 0.0.0.0)")
|
||||||
|
parser.add_argument(
|
||||||
|
"--port", type=int, default=7860, help="Port for HTTP server (default: 7860)"
|
||||||
|
)
|
||||||
|
parser.add_argument("--verbose", "-v", action="count")
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
if args.verbose:
|
||||||
|
logging.basicConfig(level=logging.DEBUG)
|
||||||
|
else:
|
||||||
|
logging.basicConfig(level=logging.INFO)
|
||||||
|
|
||||||
|
uvicorn.run(app, host=args.host, port=args.port)
|
||||||
Reference in New Issue
Block a user