https://github.com/mallorbc/brillibot-client

Easy to use voice commands API python client. Create your own commands in less than a couple of minutes by creating a JSON file.
https://github.com/mallorbc/brillibot-client

api api-client chatbot nlp nlu speech-recognition speech-to-text voice-assistant voice-commands voice-control voice-recognition

Last synced: 17 days ago
JSON representation

Easy to use voice commands API python client. Create your own commands in less than a couple of minutes by creating a JSON file.

• Host: GitHub
• URL: https://github.com/mallorbc/brillibot-client
• Owner: mallorbc
• License: agpl-3.0
• Created: 2022-10-18T16:22:47.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-24T22:26:37.000Z (about 2 years ago)
• Last Synced: 2024-10-31T20:08:23.499Z (2 months ago)
• Topics: api, api-client, chatbot, nlp, nlu, speech-recognition, speech-to-text, voice-assistant, voice-commands, voice-control, voice-recognition
• Language: Python
• Homepage:
• Size: 53.7 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Brillibot-client

## Overview

This repo gives a python package and CLI to interface with the Brillibot API.

Brillibot is an easy to use speech to command API.

It works by having a user simply define their possible commands in a JSON file with several ways they could say that command, and then provides either a file or access to a microphone to send audio over to sever that will determine what command was said in the audio.

The API is currently rate limited for public use, API keys are a possibility.

Redeployment server side takes a few minutes, thus due to the fact that development is still ongoing, expect periodic downtime.

## Requirements

ffmpeg is required for this application to work properly

## Installation

It is reccomended to use a venv before installing.

```pip install git+https://github.com/mallorbc/brillibot-client.git```

### Upgrading

If the repo was updated since you last installed, running may be needed:

```pip install git+https://github.com/mallorbc/brillibot-client.git --no-cache```

## Python Package Examples

Inside the ```/examples``` folder there are two files that show how one can use the Python package either with a file, or with a microphone.

## CLI Usage

To use the CLI, insure that you are inside the venv after installation.  The CLI is called ```brillibot_client```

To see the run options run ```brillibot_client  -h```. Providing an actions file is a must, to do so, use the ```-a``` flag

## Troubleshooting

This repo needs PortAudio to work. 

If you are having issues with the your microphone, try running the following for Ubuntu:

```

sudo apt install portaudio19-dev python3-pyaudio gcc

```

Windows:

```

pip install pipwin

```

```

pipwin install pyaudio

```

## License

This repo is licensed under the AGPL license.  See [LICENSE](LICENSE) for more information.  If you require other license options, contact me.