Geen omschrijving

user 75d0f3e7fa Update docker/login-action action to v3 (#6) 11 maanden geleden
.github 75d0f3e7fa Update docker/login-action action to v3 (#6) 11 maanden geleden
whisper.cpp @ ec7a6f04f9 9815ad778b update whisper.cpp 1 jaar geleden
.dockerignore e4de1a1d0a big bang 2 jaren geleden
.gitignore a6b423ceaa update dependencies 1 jaar geleden
.gitmodules 26f403c679 migrate to native cpp implementation 2 jaren geleden
Dockerfile 77fd627a4b Update python Docker tag to v3.12 1 jaar geleden
README.md f2183cfc3c add language parameter 2 jaren geleden
main.py cd3e70dbbc fix accessing preloaded model 2 jaren geleden
renovate.json e29743a756 Add renovate.json 1 jaar geleden
requirements.txt 0174d55123 Update dependency simplematrixbotlib to v2.10.3 11 maanden geleden
speech_recognition.py f2312f3faa non verbose wget 1 jaar geleden

README.md

Matrix Speech-To-Text Bot

Transcribes audio messages using OpenAI Whisper.

This bot is based on Simple-Matrix-Bot-Lib and whisper.cpp. It downloads audio messages from your homeserver, transcribes them locally and responds with the result as a text message.

Usage

The bot is available as an image on DockerHub. You can deploy it using docker-compose:

version: "3.7"

services:
  matrix-stt-bot:
    image: ftcaplan/matrix-stt-bot
    restart: on-failure
    volumes:
      - ./data/:/data/
    environment:
      - "HOMESERVER=https://matrix.example.com"
      - "USERNAME=@stt-bot:example.com"
      - "PASSWORD=<password>"
      - "ASR_MODEL=tiny"
      - "ASR_LANGUAGE=en"

Configuration

The bot will download the model file on first run to reduce image size. Available models are tiny.en, tiny, base.en, base, small.en, small, medium.en, medium, and large. The default is ASR_MODEL=tiny.

You can authenticate using tokens instead of a password by setting LOGIN_TOKEN=<login-token> or ACCESS_TOKEN=<access-token> instead of PASSWORD=<password>.