Remove quickstart example—moving to a separate PR
This commit is contained in:
Mark Backman
@@ -1,90 +0,0 @@
|
|||||||
# Pipecat Quickstart
|
|
||||||
|
|
||||||
Run your first Pipecat bot in under 5 minutes. This example creates a voice AI bot that you can talk to in your browser.
|
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
### Python 3.10+
|
|
||||||
|
|
||||||
Pipecat requires Python 3.10 or newer. Check your version:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python --version
|
|
||||||
```
|
|
||||||
|
|
||||||
If you need to upgrade Python, we recommend using a version manager like `uv` or `pyenv`.
|
|
||||||
|
|
||||||
### AI Service API keys
|
|
||||||
|
|
||||||
Pipecat orchestrates different AI services in a pipeline, ensuring low latency communication. In this quickstart example, we'll use:
|
|
||||||
|
|
||||||
- [Deepgram](https://console.deepgram.com/signup) for Speech-to-Text transcriptions
|
|
||||||
- [OpenAI](https://auth.openai.com/create-account) for LLM inference
|
|
||||||
- [Cartesia](https://play.cartesia.ai/sign-up) for Text-to-Speech audio generation
|
|
||||||
|
|
||||||
Have your API keys ready. We'll add them to your `.env` shortly.
|
|
||||||
|
|
||||||
## Setup
|
|
||||||
|
|
||||||
1. Set up a virtual environment
|
|
||||||
|
|
||||||
From the root directory of the `pipecat` repo, run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd examples/quickstart
|
|
||||||
python -m venv .venv
|
|
||||||
source .venv/bin/activate # On Windows: .venv\Scripts\activate
|
|
||||||
```
|
|
||||||
|
|
||||||
> Using `uv`? Create your venv using: `uv venv && source .venv/bin/activate`.
|
|
||||||
|
|
||||||
2. Install packages
|
|
||||||
|
|
||||||
Then, install the requirements:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install -r requirements.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
> Using `uv`? Install requirements using: `uv pip install -r requirements.txt`.
|
|
||||||
|
|
||||||
3. Configure environment variables
|
|
||||||
|
|
||||||
Create a `.env` file:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cp env.example .env
|
|
||||||
```
|
|
||||||
|
|
||||||
Then, add your API keys:
|
|
||||||
|
|
||||||
```
|
|
||||||
DEEPGRAM_API_KEY=your_deepgram_api_key
|
|
||||||
OPENAI_API_KEY=your_openai_api_key
|
|
||||||
CARTESIA_API_KEY=your_cartesia_api_key
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Run the example
|
|
||||||
|
|
||||||
Run your bot using:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python bot.py
|
|
||||||
```
|
|
||||||
|
|
||||||
> Using `uv`? Run your bot using: `uv run bot.py`.
|
|
||||||
|
|
||||||
Connect to your bot in a browser at http://localhost:7860.
|
|
||||||
|
|
||||||
> 💡 First run note: The initial startup may take ~10 seconds as Pipecat downloads required models, like the Silero VAD model.
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
- **Browser permissions**: Make sure to allow microphone access when prompted by your browser.
|
|
||||||
- **Connection issues**: If the WebRTC connection fails, first try a different browser. If that fails, make sure you don't have a VPN or firewall rules blocking traffic. WebRTC uses UDP to communicate.
|
|
||||||
- **Audio issues**: Check that your microphone and speakers are working and not muted.
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- **Read the docs**: Check out [Pipecat's docs](https://docs.pipecat.ai/) for guides and reference information.
|
|
||||||
- **Join Discord**: Join [Pipecat's Discord server](https://discord.gg/pipecat) to get help and learn about what others are building.
|
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
#
|
|
||||||
# Copyright (c) 2024–2025, Daily
|
|
||||||
#
|
|
||||||
# SPDX-License-Identifier: BSD 2-Clause License
|
|
||||||
#
|
|
||||||
|
|
||||||
import argparse
|
|
||||||
import os
|
|
||||||
|
|
||||||
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.processors.frameworks.rtvi import RTVIConfig, RTVIObserver, RTVIProcessor
|
|
||||||
from pipecat.services.cartesia.tts import CartesiaTTSService
|
|
||||||
from pipecat.services.deepgram.stt import DeepgramSTTService
|
|
||||||
from pipecat.services.openai.llm import OpenAILLMService
|
|
||||||
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
|
||||||
|
|
||||||
load_dotenv(override=True)
|
|
||||||
|
|
||||||
|
|
||||||
async def run_bot(transport: BaseTransport, _: argparse.Namespace, handle_sigint: bool):
|
|
||||||
logger.info(f"Starting bot")
|
|
||||||
|
|
||||||
stt = DeepgramSTTService(api_key=os.getenv("DEEPGRAM_API_KEY"))
|
|
||||||
|
|
||||||
tts = CartesiaTTSService(
|
|
||||||
api_key=os.getenv("CARTESIA_API_KEY"),
|
|
||||||
voice_id="71a7ad14-091c-4e8e-a314-022ece01c121", # British Reading Lady
|
|
||||||
)
|
|
||||||
|
|
||||||
llm = OpenAILLMService(api_key=os.getenv("OPENAI_API_KEY"))
|
|
||||||
|
|
||||||
messages = [
|
|
||||||
{
|
|
||||||
"role": "system",
|
|
||||||
"content": "You are a friendly AI assistant. Respond naturally and keep your answers conversational.",
|
|
||||||
},
|
|
||||||
]
|
|
||||||
|
|
||||||
context = OpenAILLMContext(messages)
|
|
||||||
context_aggregator = llm.create_context_aggregator(context)
|
|
||||||
|
|
||||||
rtvi = RTVIProcessor(config=RTVIConfig(config=[]))
|
|
||||||
|
|
||||||
pipeline = Pipeline(
|
|
||||||
[
|
|
||||||
transport.input(), # Transport user input
|
|
||||||
rtvi, # RTVI processor
|
|
||||||
stt,
|
|
||||||
context_aggregator.user(), # User responses
|
|
||||||
llm, # LLM
|
|
||||||
tts, # TTS
|
|
||||||
transport.output(), # Transport bot output
|
|
||||||
context_aggregator.assistant(), # Assistant spoken responses
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
task = PipelineTask(
|
|
||||||
pipeline,
|
|
||||||
params=PipelineParams(
|
|
||||||
enable_metrics=True,
|
|
||||||
enable_usage_metrics=True,
|
|
||||||
),
|
|
||||||
observers=[RTVIObserver(rtvi)],
|
|
||||||
)
|
|
||||||
|
|
||||||
@transport.event_handler("on_client_connected")
|
|
||||||
async def on_client_connected(transport, client):
|
|
||||||
logger.info(f"Client connected")
|
|
||||||
# Kick off the conversation.
|
|
||||||
messages.append({"role": "system", "content": "Say hello and briefly introduce yourself."})
|
|
||||||
await task.queue_frames([context_aggregator.user().get_context_frame()])
|
|
||||||
|
|
||||||
@transport.event_handler("on_client_disconnected")
|
|
||||||
async def on_client_disconnected(transport, client):
|
|
||||||
logger.info(f"Client disconnected")
|
|
||||||
await task.cancel()
|
|
||||||
|
|
||||||
runner = PipelineRunner(handle_sigint=handle_sigint)
|
|
||||||
|
|
||||||
await runner.run(task)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
from pipecat.runner.local import main
|
|
||||||
|
|
||||||
# SmallWebRTCTransport for a P2P WebRTC connection
|
|
||||||
transport_params = {
|
|
||||||
"webrtc": lambda: TransportParams(
|
|
||||||
audio_in_enabled=True,
|
|
||||||
audio_out_enabled=True,
|
|
||||||
vad_analyzer=SileroVADAnalyzer(),
|
|
||||||
),
|
|
||||||
}
|
|
||||||
|
|
||||||
main(run_bot, transport_params=transport_params)
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
DEEPGRAM_API_KEY=your_deepgram_api_key
|
|
||||||
OPENAI_API_KEY=your_openai_api_key
|
|
||||||
CARTESIA_API_KEY=your_cartesia_api_key
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
pipecat-ai[webrtc,silero,deepgram,openai,cartesia,runner]
|
|
||||||
pipecat-ai-small-webrtc-prebuilt
|
|
||||||
Reference in New Issue
Block a user