Skip to content

Commit 818e46b

Browse files
mattieruthmattieruth
committed
Adding a new example to exemplify the bot-output RTVI event
1 parent c32a4e3 commit 818e46b

File tree

12 files changed

+2731
-0
lines changed

12 files changed

+2731
-0
lines changed

‎code-helper/.gitignore‎

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[codz]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py.cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
# Pipfile.lock
96+
97+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
# poetry.lock
109+
# poetry.toml
110+
111+
# pdm
112+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115+
# pdm.lock
116+
# pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# pixi
121+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122+
# pixi.lock
123+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124+
# in the .venv directory. It is recommended not to include this directory in version control.
125+
.pixi
126+
127+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128+
__pypackages__/
129+
130+
# Celery stuff
131+
celerybeat-schedule
132+
celerybeat.pid
133+
134+
# Redis
135+
*.rdb
136+
*.aof
137+
*.pid
138+
139+
# RabbitMQ
140+
mnesia/
141+
rabbitmq/
142+
rabbitmq-data/
143+
144+
# ActiveMQ
145+
activemq-data/
146+
147+
# SageMath parsed files
148+
*.sage.py
149+
150+
# Environments
151+
.env
152+
.envrc
153+
.venv
154+
env/
155+
venv/
156+
ENV/
157+
env.bak/
158+
venv.bak/
159+
160+
# Spyder project settings
161+
.spyderproject
162+
.spyproject
163+
164+
# Rope project settings
165+
.ropeproject
166+
167+
# mkdocs documentation
168+
/site
169+
170+
# mypy
171+
.mypy_cache/
172+
.dmypy.json
173+
dmypy.json
174+
175+
# Pyre type checker
176+
.pyre/
177+
178+
# pytype static type analyzer
179+
.pytype/
180+
181+
# Cython debug symbols
182+
cython_debug/
183+
184+
# PyCharm
185+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
186+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
187+
# and can be added to the global gitignore or merged into this file. For a more nuclear
188+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
189+
# .idea/
190+
191+
# Abstra
192+
# Abstra is an AI-powered process automation framework.
193+
# Ignore directories containing user credentials, local state, and settings.
194+
# Learn more at https://abstra.io/docs
195+
.abstra/
196+
197+
# Visual Studio Code
198+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
199+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
200+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
201+
# you could uncomment the following to ignore the entire vscode folder
202+
# .vscode/
203+
204+
# Ruff stuff:
205+
.ruff_cache/
206+
207+
# PyPI configuration file
208+
.pypirc
209+
210+
# Marimo
211+
marimo/_static/
212+
marimo/_lsp/
213+
__marimo__/
214+
215+
# Streamlit
216+
.streamlit/secrets.toml
217+
218+
# Node.js (client/)
219+
client/node_modules/
220+
client/.next/
221+
client/out/
222+
client/dist/
223+
client/.vite/
224+
client/.turbo/
225+
client/.vercel
226+
client/.env*.local
227+
client/*.tsbuildinfo

‎code-helper/README.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# code-helper
2+
3+
A Pipecat AI voice agent built with a cascade pipeline (STT → LLM → TTS).
4+
5+
## Configuration
6+
7+
- **Bot Type**: Web
8+
- **Transport(s)**: SmallWebRTC
9+
- **Pipeline**: Cascade
10+
- **STT**: Deepgram
11+
- **LLM**: OpenAI
12+
- **TTS**: ElevenLabs
13+
- **Features**:
14+
- Transcription
15+
- smart-turn v3
16+
- Observability (Whisker + Tail)
17+
18+
## Setup
19+
20+
### Server
21+
22+
1. **Navigate to server directory**:
23+
24+
```bash
25+
cd server
26+
```
27+
28+
2. **Install dependencies**:
29+
30+
```bash
31+
uv sync
32+
```
33+
34+
3. **Configure environment variables**:
35+
36+
```bash
37+
cp .env.example .env
38+
# Edit .env and add your API keys
39+
```
40+
41+
4. **Run the bot**:
42+
43+
- SmallWebRTC: `uv run bot.py`
44+
45+
### Client
46+
47+
1. **Navigate to client directory**:
48+
49+
```bash
50+
cd client
51+
```
52+
53+
2. **Install dependencies**:
54+
55+
```bash
56+
npm install
57+
```
58+
59+
3. **Run development server**:
60+
61+
```bash
62+
npm run dev
63+
```
64+
65+
4. **Open browser**:
66+
67+
http://localhost:5173
68+
69+
## Project Structure
70+
71+
```
72+
code-helper/
73+
├── server/ # Python bot server
74+
│ ├── bot.py # Main bot implementation
75+
│ ├── pyproject.toml # Python dependencies
76+
│ ├── .env.example # Environment variables template
77+
│ ├── .env # Your API keys (git-ignored)
78+
│ └── ...
79+
├── client/ # Vanilla application
80+
│ ├── src/ # Client source code
81+
│ ├── package.json # Node dependencies
82+
│ └── ...
83+
├── .gitignore # Git ignore patterns
84+
└── README.md # This file
85+
```
86+
## Observability
87+
88+
This project includes observability tools to help you debug and monitor your bot:
89+
90+
### Whisker - Live Pipeline Debugger
91+
92+
**Whisker** is a live graphical debugger that lets you visualize pipelines and debug frames in real time.
93+
94+
With Whisker you can:
95+
96+
- 🗺️ View a live graph of your pipeline
97+
- ⚡ Watch frame processors flash in real time as frames pass through them
98+
- 📌 Select a processor to inspect the frames it has handled
99+
- 🔍 Filter frames by name to quickly find the ones you care about
100+
- 🧵 Select a frame to trace its full path through the pipeline
101+
- 💾 Save and load previous sessions for review and troubleshooting
102+
103+
**To use Whisker:**
104+
105+
1. Run an ngrok tunnel to expose your bot:
106+
107+
```bash
108+
ngrok http 9090
109+
```
110+
111+
> Tip: Use `--subdomain` for a repeatable ngrok URL
112+
113+
2. Navigate to [https://whisker.pipecat.ai/](https://whisker.pipecat.ai/) and enter your ngrok URL (e.g., `your-subdomain.ngrok.io`)
114+
115+
3. Once your bot is running, press connect
116+
117+
### Tail - Terminal Dashboard
118+
119+
**Tail** is a terminal dashboard that lets you monitor your Pipecat sessions in real time.
120+
121+
With Tail you can:
122+
123+
- 📜 Follow system logs in real time
124+
- 💬 Track conversations as they happen
125+
- 🔊 Monitor user and agent audio levels
126+
- 📈 Keep an eye on service metrics and usage
127+
128+
**To use Tail:**
129+
130+
1. Run your bot (in one terminal)
131+
132+
2. Launch Tail in another terminal:
133+
```bash
134+
pipecat tail
135+
```
136+
137+
## Learn More
138+
139+
- [Pipecat Documentation](https://docs.pipecat.ai/)
140+
- [Pipecat GitHub](https://github.com/pipecat-ai/pipecat)
141+
- [Pipecat Examples](https://github.com/pipecat-ai/pipecat-examples)
142+
- [Discord Community](https://discord.gg/pipecat)

0 commit comments

Comments
 (0)