STT
- class pipecat.services.azure.stt.AzureSTTService(*, api_key, region, language=Language.EN_US, sample_rate=None, **kwargs)[source]
Bases:
STTService- Parameters:
api_key (str)
region (str)
language (Language)
sample_rate (int | None)
- can_generate_metrics()[source]
- Return type:
bool
- async run_stt(audio)[source]
Run speech-to-text on the provided audio data.
This method must be implemented by subclasses to provide actual speech recognition functionality.
- Parameters:
audio (bytes) – Raw audio bytes to transcribe.
- Yields:
Frame – Frames containing transcription results (typically TextFrame).
- Return type:
AsyncGenerator[Frame, None]
- async start(frame)[source]
Start the STT service.
- Parameters:
frame (StartFrame) – The start frame containing initialization parameters.
- async stop(frame)[source]
Stop the AI service.
Called when the service should stop processing. Subclasses should override this method to perform cleanup operations.
- Parameters:
frame (EndFrame) – The end frame.
- async cancel(frame)[source]
Cancel the AI service.
Called when the service should cancel all operations. Subclasses should override this method to handle cancellation logic.
- Parameters:
frame (CancelFrame) – The cancel frame.