https://github.com/fabio-garavini/ha-groq-whisper-stt-api

HACS custom integration for using GroqCloud speech-to-text (Whisper) API in the Assist pipeline, reducing the workload on the Home Assistant server.
https://github.com/fabio-garavini/ha-groq-whisper-stt-api

groq-api home-assistant stt whisper

Last synced: 17 days ago
JSON representation

HACS custom integration for using GroqCloud speech-to-text (Whisper) API in the Assist pipeline, reducing the workload on the Home Assistant server.

• Host: GitHub
• URL: https://github.com/fabio-garavini/ha-groq-whisper-stt-api
• Owner: fabio-garavini
• License: agpl-3.0
• Archived: true
• Created: 2024-08-14T17:53:21.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-08-16T12:39:16.000Z (6 months ago)
• Last Synced: 2024-09-30T19:03:05.831Z (4 months ago)
• Topics: groq-api, home-assistant, stt, whisper
• Language: Python
• Homepage:
• Size: 26.4 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GroqCloud Whisper STT API integration for Home Assistant 🏠🎙️

This is a custom integration for using GroqCloud speech-to-text API in the Assist pipeline, reducing the workload on the Home Assistant server.

Whisper (whisper-large-v3) usage is free up to 28800 audio seconds per day! And no card required!

## Requirements 📖

- An GroqCloud account 👤  --> You can create one [here](https://console.groq.com/login)

- An `API Key` 🔑 --> You can generate one [here](https://console.groq.com/keys)

## How to install ⚙️

Before configuring the integration you must first install the `custom_integration`. You can do it through HACS or manually

### HACS ✨

1. **Add** ➕ [this repository](https://my.home-assistant.io/redirect/hacs_repository/?owner=fabio-garavini&repository=ha-groq-whisper-stt-api&category=integration) to your HACS repositories:

    - **Click** on this link ⤵️

      [![Add Repository to HACS](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=fabio-garavini&repository=ha-groq-whisper-stt-api&category=integration)

    - Or **copy** this url ⤵️ and paste into your HACS custom repostories

      ```url

      https://github.com/fabio-garavini/ha-groq-whisper-stt-api

      ```

2. **Install** 💻 the `GroqCloud Whisper` integration

3. **Restart** 🔁 Home Assistant

### Manual Install ⌨️

1. **Download** this repository

2. **Copy** everything inside the `custom_components` folder into your Home Assistant's `custom_components` folder.

3. **Restart** Home Assistant

## Configuration 🔧

These are the parameters that you can configure:

- `api_key`: (Required) GroqCloud api key

- `model`: (Required) At the moment the only model available is `whisper-large-v3`

- `temperature`: (Optional) Sampling temperature between 0 and 1. Default `0`

- `prompt`: (Optional) Can be used to **improve speech recognition** of words or even names. Default `""`

  
You have to provide a list of words or names separated by a comma `, `

  
Example: `"open, close, Chat GPT-3, DALL·E"`.

Now you can set it up through your Home Assistant Dashboard (YAML configuration not supported).

### Home Assistant Dashboard 💻

- Configure the integration by **clicking here** ⤵️

  [![Add Repository to HACS](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=groqcloud_whisper)

- Or navigate to your `Devices & services` page and click `+ Add Integration`