Metadata-Version: 2.4
Name: sonusai-asr-faster-whisper
Version: 1.3.0
Summary: Faster-whisper ASR tools for SonusAI
Project-URL: Homepage, https://aaware.com
Author-email: Chris Eddington <chris@aaware.com>, Jason Calderwood <jason@aaware.com>
License-Expression: GPL-3.0-only
Requires-Python: <3.15,>=3.13
Requires-Dist: aixplain~=0.2.44
Requires-Dist: ctranslate2~=4.7.1
Requires-Dist: deepgram-sdk~=7.1.1
Requires-Dist: faster-whisper~=1.2.1
Requires-Dist: sonusai~=1.3.2
Description-Content-Type: text/markdown

# SonusAI ASR Faster Whisper

Faster-Whisper ASR tools for SonusAI.

This package provides a SonusAI-compatible Automatic Speech Recognition (ASR) plugin backed by `faster-whisper`.

## Overview

- Integrates Faster-Whisper transcription into SonusAI workflows.
- Exposes ASR functions under `sonusai_asr_faster_whisper/asr_functions/`.
- Returns SonusAI-native `ASRResult` objects for downstream processing.

## Requirements

- Python `>=3.13, <3.15`
- Dependencies are managed via `uv` and defined in `pyproject.toml`

## Installation

Install dependencies for development:

```bash
uv sync
```

## Usage

Core exported functions:

- `faster_whisper_validate(**config)`
- `faster_whisper(audio, **config)`

Minimum config requirement:

- `model`: Faster-Whisper model name/path

Common optional config keys:

- `device` (default: `"cpu"`)
- `cpu_threads` (default: `1`)
- `compute_type` (default: `"int8"`)
- `beam_size` (default: `5`)

## Development

Quality and validation commands:

```bash
ruff check .
ruff format .
pytest
```

Additional project context and standards are documented in:

- `AGENTS.md`
- `.context/overview.md`
- `.context/architecture.md`
- `.context/cli_commands.md`
- `.context/standards.md`
