/voice-stream

A framework for creating voice based agents. Integrations LLMs with speech recognition and text-to-speech

Primary LanguagePythonMIT LicenseMIT

voice-stream: Creating voice bots from LLMs.

PyPI Tests Documentation Status License: MIT Python Versions Black Poetry

Quick Install

VoiceStream is distributed on PyPI. To install, run:

pip install voice-stream

This will install the bare minimum requirements of VoiceStream. A lot of the value of VoiceStream comes when integrating it with different audio sources, speech recognition and text to speech systems. By default, the dependencies needed to do that are NOT installed. You will need to install the dependencies for specific integrations separately.

🤔 What is VoiceStream

VoiceStream is a framework for building voicebots using language models.

  • Integrates with LangChain so you can take any LLM application.
  • Makes it easy to use different Text-To-Speech and Speech Recognition models
  • Uses asyncio and streaming throughout to provide a great user experience.
  • Handles voice specific conversation flows, like interrupting the current speaker.

VoiceStream is built to make it easy to build voice applications on top of LangChain, but can work with any LLM framework.

🧱 What can you build with VoiceStream?

  • 🤖 VoiceBots - Chatbots that you can talk and listen to instead of typing.
  • 📞 Automated Telephone Calls - Make automated phone calls powered by LLMs and rich-content
  • 🧑‍🏫 Voice Assistants - Build your own voice assistant that can do anything you want.

🚀 How does VoiceStream help?

The main value props of VoiceStream are:

  1. Components - Modular and easy-to-use components for audio input/output, speech recognition, and text to speech.
  2. Streaming - Audio programming can be tricky in Python. VoiceStream provides simple streaming commands that make it easy to string together audio applications.

📖 Documentation

Please see here for full documentation, which includes:

From here, explore the rest of the documentation to learn more about VoiceStream.

  • Quickstart - Build a fully functional voicebot in 15 minutes.
  • Concepts - A methodical intro to the concepts underlying VoiceStream.
  • Cookbook - How to take advantage of the various capability of VoiceStream.
  • GitHub Examples - To view and run the code for fully worked examples.
  • API Reference - If you are into reading API docs directly.

💁 Contributing

VoiceStream is a volunteer maintained open source project, and we welcome contributions of all forms. Please take a look at our Contributing Guide for more information.

🏛️ License

This project is licensed under the MIT License.