Struct TranscriptionPipeline 

pub struct TranscriptionPipeline { /* private fields */ }

Single-chunk Parakeet v2 transcription pipeline

This is the base scriptrs entry point for audio that already fits inside a single Parakeet window. It expects mono 16kHz audio samples as &[f32].

If the input is longer than TranscriptionConfig::max_audio_samples, this pipeline returns TranscriptionError::AudioTooLong instead of splitting it. Use LongFormTranscriptionPipeline with the long-form feature if you want scriptrs to own chunk planning internally.

Implementations

impl TranscriptionPipeline

pub fn from_dir( models_dir: impl Into<PathBuf>, ) -> Result<Self, TranscriptionError>

Build a transcription pipeline from a local model directory

The directory must contain the Parakeet runtime bundle expected by ModelBundle::from_dir.

pub fn from_bundle(bundle: ModelBundle) -> Result<Self, TranscriptionError>

Build a transcription pipeline from a resolved model bundle

pub fn from_pretrained() -> Result<Self, TranscriptionError>

Download models and build a transcription pipeline

With the default configuration this resolves models from avencera/scriptrs-models on Hugging Face. Set SCRIPTRS_MODELS_DIR to force a local bundle or SCRIPTRS_MODELS_REPO to override the repo.

pub fn run( &self, audio: &[f32], ) -> Result<TranscriptionResult, TranscriptionError>

Transcribe a single chunk of audio

audio must be mono 16kHz samples. Empty input returns TranscriptionError::EmptyAudio. Oversized input returns TranscriptionError::AudioTooLong.

pub fn run_with_config( &self, audio: &[f32], config: &TranscriptionConfig, ) -> Result<TranscriptionResult, TranscriptionError>

Transcribe a single chunk of audio with an explicit config

This is mainly useful if you want to reuse the same pipeline with a tweaked TranscriptionConfig instead of the default frontend settings.

pub fn config(&self) -> &TranscriptionConfig

Return the default pipeline config

pub fn bundle(&self) -> &ModelBundle

Return the resolved model bundle

Trait Implementations

impl Clone for TranscriptionPipeline

fn clone(&self) -> TranscriptionPipeline

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TranscriptionPipeline

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.