freetalkbot

Implementation of communication channels to interact with LLM/NLU bot assistants.

• Voice: using Audiosocket Asterisk protocol
• Whatsapp: using whatsmeow library. NO need of Whatsapp Business account, 100% free.

Dependencies

• Golang. Version recommended: 1.22
• Golang packages. Check go.mod file
• whatsapp-media-decrypt tool
• picotts

Install go dependencies with go mod tidy. Run it as well if you add a new package

For better golang developer experience you can install golang-air

Environment variables

Check the variables in env.example file. Create .env file with cp -a .env.example .env and modify it with your values. Read carefully the file to know which variables are relevant for each component

Run

You can pull the docker image and run it with the environment variables set up. Choose your communication channel between whatsapp or audio

docker pull ghcr.io/felipem1210/freetalkbot/freetalkbot:latest
COM_CHANNEL=audio #or whatsapp
ocker run -it --rm --env-file ./.env ghcr.io/felipem1210/freetalkbot/freetalkbot:latest freetalkbot init -c $COM_CHANNEL

Development

For local development you can use docker or podman to raise up the components defined in the docker-compose.yml file. These components are:

• Asterisk
• Anthropic
• Rasa assistant
• Rasa Actions server
• Whisper ASR (optional)
• Audio bot server
• Whatsapp bot server

Build docker images

Run make build. This will build locally all the images needed for components

Run the solution

After setting up properly the environment variables:

• Without whisper-asr: make run
• With whisper-asr: make run-whisper-asr

Configure asterisk

1. Once raised up, copy local-config to container-config cp -a asterisk/local-config/* asterisk/container-config/
2. Restart asterisk container docker-compose restart asterisk

Asterisk is raised up in network_mode brige. The asterisk configuration files are mapped in folder asterisk/container-config

Register SIP/IAX endpoint in a softphone

• For SIP checkout pjsip_endpoint.conf file in asterisk/container-config folder.
• For IAX checkout iax.conf file in asterisk/local-config folder.

Communication Channels

You can communicate with your chatbot assistant via two channels.

Audio channel

The docker-compose file alreay deploys it, but if you want to develop on it locally instead in the docker container:

1. Change envars in .env file:

RASA_URL=http://localhost:5005
CALLBACK_SERVER_URL=http://host.docker.internal:5034/bot
WHISPER_ASR_URL=http://host.docker.internal:9000 #if you are using it
ANTHROPIC_URL=http://host.docker.internal:8000/chat #if you are using anthropic

2. Set the envars with export $(cat ./.env | xargs)

3. Install pkg-config: brew install pkg-config

4. Change the audiosocket server host in asterisk/container-config/extensions_local.conf

 same = n,AudioSocket(40325ec2-5efd-4bd3-805f-53576e581d13,host.docker.internal:8080)

4. Run make run-local-audio

Whatsapp channel

Same variables than audio bot are needed, just change the make command make run-local-whatsapp

After initialize you will see in the logs a QR code. Scan that QR code with the whatsapp account that you will use. If you can't scan the QR code you can also link the whatsapp account using a pair code. For that you must set the envar PAIR_PHONE_NUMBER with your phone number using format show in the .env.example. If you don't need the pair code don't set this envar.

Once you pair your whatsapp account the session will be stored in a sqlite file. This file is created inside the container but mapped through a docker volume, so you can use it when you want to develop locally. If you delete this file you will have to login again using a new QR code.

The channel is prepared to receive text or voice messages.

Assistants

Currently the channels are integrated with two LLM/NLU assistants.

• RASA
• Anthropic

Gratitude and Thanks

The following projects inspired to the construction of this one:

• audiosocket
• whatsmeow-quickstart
• Whisper ASR webservice