Skip to content

README.md

Latest commit

 

History

History
53 lines (33 loc) · 1.39 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.39 KB

Pipecat Flows: Quickstart

This quickstart example will help you set up your first Flow and explain to you the basics of using Flows.

Dependencies

Installation

  1. Setup your virtual environment:
python3 -m venv venv
source venv/bin/activate
  1. Install Pipecat Flows:
pip install pipecat-ai-flows
  1. Install the quickstart requirements:
pip install -r requirements.txt
  1. Update your .env file with API keys for Cartesia and Google Gemini. You can find the environment variable names in the env.example.

Run the example

The example makes use of:

  • SmallWebRTCTransport: A free peer-to-peer WebRTC transport, which sends audio to/from the bot
  • Cartesia: A service provider for STT and TTS
  • Google Gemini: An LLM inference provider
  1. From within the /examples/quickstart directory, run:
python hello_world.py

  1. Connect to http://localhost:7860 using your web browser.

  2. Press connect to start the example.

The example is a simple bot that asks for your favorite color and leaves. While this is a simple example, it shows all of the basics of building with Flows.

Check out the source code to learn more.