Skip to content

Latest commit

 

History

History
119 lines (81 loc) · 3.04 KB

README.md

File metadata and controls

119 lines (81 loc) · 3.04 KB
Raw

blablado

blablado is an extensible Assistant, that listens to your voice and can execute custom Python functions you provided. It can speak as well. It is based on LangChain and OpenAI's API. You need an openai API account to use it.

Usage: API

You can use it from Python (see example notebook) by

  • initializing an Assistant,
from blablado import Assistant
assistant = Assistant()
  • providing functions/tools and
from datetime import datetime

@assistant.register_tool
def book_room(room:str, author:str, start:datetime, end:datetime):
    """Book a room for a specific person from start to end time."""
    
    print(f"""
    Booking {room} for {author} from {start} to {end}.
    """)
  • prompting for tasks
assistant.do("Hi I'm Robert, please book room A03.21 for me from 3 to 4 pm tomorrow. Thanks")

Output:

I have successfully booked room A03.21 for Robert from 3 to 4 pm tomorrow.

Usage: Microphone

You can also use it via microphone (see example notebook). You need to install some more library before this works:

pip install SpeechRecognition pydub gTTS PyAudio

Therefore, it is recommended to print out the list of available microphones like this:

from blablado import list_microphones
list_microphones()

Example output:

['Microsoft Sound Mapper - Input',
 'Microphone (KLICK&SHOW Audio)',
 'AI Noise-cancelling Input (ASUS',
 'Headset (MAJOR IV Hands-Free AG',
 'Microphone Array (Realtek(R) Au']

Then, choose the right microphone after initializing the assistant:

from blablado import Assistant
assistant = Assistant()
assistant.microphone_index = 3

You can then call the assistant to listen to your voice and execute the function you want to call:

assistant.listen()

Usage: Voice output

To make the voice output work as well, just activate the voice when initializing the assistant:

from blablado import Assistant
assistant = Assistant(has_voice=True)

Installation

blablado is available on pypi and can be installed using pip. It is recommended to install it in a virtual environment, e.g. set up with mamba.

mamba create --name bla python=3.9

mamba activate bla

pip install blablado

To make the voice-output work (optional), consider installing ffmpeg using mamba.

mamba install ffmpeg

Issues

If you encounter any problems or want to provide feedback or suggestions, please create a thread on image.sc along with a detailed description and tag [@haesleinhuepf].

Acknowledgements

Parts of the code reused here were originally written by kevinyamauchi for the bia-bob project.