jason.woltjeandClaude Opus 4.6
c40373fa3b
Add SpeechModule with provider interfaces and service skeleton for multi-tier TTS fallback (premium -> default -> fallback) and STT transcription support. Includes 27 unit tests covering provider selection, fallback logic, and availability checks. - ISTTProvider interface with transcribe/isHealthy methods - ITTSProvider interface with synthesize/listVoices/isHealthy methods - Shared types: SpeechTier, TranscriptionResult, SynthesisResult, etc. - SpeechService with graceful TTS fallback chain - NestJS injection tokens (STT_PROVIDER, TTS_PROVIDERS) - SpeechModule registered in AppModule - ConfigModule integration via speechConfig registerAs factory Co-Authored-By: Claude Opus 4.6 <[email protected]>
53 lines
1.4 KiB
TypeScript
53 lines
1.4 KiB
TypeScript
/**
|
|
* STT Provider Interface
|
|
*
|
|
* Defines the contract for speech-to-text provider implementations.
|
|
* All STT providers (e.g., Speaches/faster-whisper) must implement this interface.
|
|
*
|
|
* Issue #389
|
|
*/
|
|
|
|
import type { TranscribeOptions, TranscriptionResult } from "./speech-types";
|
|
|
|
/**
|
|
* Interface for speech-to-text providers.
|
|
*
|
|
* Implementations wrap an OpenAI-compatible API endpoint for transcription.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* class SpeachesProvider implements ISTTProvider {
|
|
* readonly name = "speaches";
|
|
*
|
|
* async transcribe(audio: Buffer, options?: TranscribeOptions): Promise<TranscriptionResult> {
|
|
* // Call speaches API via OpenAI SDK
|
|
* }
|
|
*
|
|
* async isHealthy(): Promise<boolean> {
|
|
* // Check endpoint health
|
|
* }
|
|
* }
|
|
* ```
|
|
*/
|
|
export interface ISTTProvider {
|
|
/** Provider name for logging and identification */
|
|
readonly name: string;
|
|
|
|
/**
|
|
* Transcribe audio data to text.
|
|
*
|
|
* @param audio - Raw audio data as a Buffer
|
|
* @param options - Optional transcription parameters
|
|
* @returns Transcription result with text and metadata
|
|
* @throws {Error} If transcription fails
|
|
*/
|
|
transcribe(audio: Buffer, options?: TranscribeOptions): Promise<TranscriptionResult>;
|
|
|
|
/**
|
|
* Check if the provider is healthy and available.
|
|
*
|
|
* @returns true if the provider endpoint is reachable and ready
|
|
*/
|
|
isHealthy(): Promise<boolean>;
|
|
}
|