Metadata-Version: 2.4
Name: livekit-plugins-reson8
Version: 0.1.0
Summary: Reson8 STT plugin for LiveKit Agents
Project-URL: Homepage, https://github.com/reson8lab/livekit-plugins-reson8
Project-URL: Repository, https://github.com/reson8lab/livekit-plugins-reson8
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: agents,livekit,reson8,speech-to-text,stt
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Requires-Dist: httpx>=0.28
Requires-Dist: livekit-agents[codecs]>=1.0
Requires-Dist: websockets>=13.0
Description-Content-Type: text/markdown

# livekit-plugins-reson8

[Reson8](https://reson8.dev) STT plugin for [LiveKit Agents](https://github.com/livekit/agents).

Supports real-time streaming and prerecorded speech-to-text across Dutch, English, French, German, Italian, Polish, Portuguese, Spanish, and Swedish.

## Installation

```bash
pip install livekit-plugins-reson8
```

## Usage

```python
from livekit.plugins import reson8

stt = reson8.STT(
    api_key="your-api-key",   # or set RESON8_API_KEY
    language="nl",
)
```

### With a Voice Agent

```python
from livekit.agents.voice import VoiceAgent
from livekit.plugins import openai, reson8

agent = VoiceAgent(
    stt=reson8.STT(language="nl"),
    llm=openai.LLM(),
    tts=openai.TTS(),
)
```

### With a Custom Model

```python
stt = reson8.STT(
    language="nl",
    custom_model_id="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
)
```

## Configuration

| Parameter | Env var | Default |
|---|---|---|
| `api_key` | `RESON8_API_KEY` | *required* |
| `api_url` | `RESON8_API_URL` | `https://api.reson8.dev` |
| `language` | -- | `nl` |
| `custom_model_id` | -- | `None` |
| `sample_rate` | -- | `16000` |
| `include_timestamps` | -- | `False` |
| `include_words` | -- | `False` |
| `include_confidence` | -- | `False` |

## Running the example

```bash
cp .env.example .env
# Fill in your keys
python examples/voice_agent.py dev
```
