Leopard Speech-to-Text
Rust Quick Start

Platforms

• Linux (x86_64)
• macOS (x86_64, arm64)
• Windows (x86_64)
• Raspberry Pi (3, 4, 5)

Requirements

• Picovoice Account & AccessKey
• Rust 1.54+
• Cargo

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Download and install Rust.

2. Add pv_leopard to the Cargo.toml manifest:

[dependencies]
pv_leopard = "*"

Usage

Create an instance of the engine:

use leopard::LeopardBuilder;

let access_key = "${ACCESS_KEY}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)

let leopard: Leopard = LeopardBuilder::new()
    .access_key(access_key)
    .init()
    .expect("Unable to create Leopard");

Transcribe an audio file:

if let Ok(leopard_transcript) = leopard.process_file("${AUDIO_PATH}") {
    println!("{}", leopard_transcript.transcript);
}

Model File

The Leopard Speech-to-Text Rust SDK comes preloaded with a default English language model (.pv file). Default models for other supported languages can be found in the Leopard Speech-to-Text GitHub repository.

Create custom language models using the Picovoice Console. Here you can train language models with custom vocabulary and boost words in the existing vocabulary.

Pass in the .pv file via the .model_path() Builder argument:

let leopard: Leopard = LeopardBuilder::new()
    .access_key("${ACCESS_KEY}")
    .model_path("${MODEL_FILE_PATH}")
    .init()
    .expect("Unable to create Leopard");

Word Metadata

Along with the transcript, Leopard Speech-to-Text returns metadata for each transcribed word. Available metadata items are:

• Start Time: Indicates when the word started in the transcribed audio. Value is in seconds.
• End Time: Indicates when the word ended in the transcribed audio. Value is in seconds.
• Confidence: Leopard Speech-to-Text's confidence that the transcribed word is accurate. It is a number within [0, 1].
• Speaker Tag: If speaker diarization is enabled on initialization, the speaker tag is a non-negative integer identifying unique speakers, with 0 reserved for unknown speakers. If speaker diarization is not enabled, the value will always be -1.

Demo

For the Leopard Speech-to-Text Rust SDK, we offer demo applications that demonstrate how to use the Speech-to-Text engine on audio files.

Setup

Clone the Leopard Speech-to-Text repository from GitHub using HTTPS:

git clone --recurse-submodules https://github.com/Picovoice/leopard.git

Usage

Use the --help flag to see the usage options for the demo:

leopard/demo/rust/filedemo
cargo run --release -- --help

Run the following command to transcribe an audio file:

cargo run --release -- --access_key ${ACCESS_KEY} --input_audio_path ${AUDIO_PATH}

For more information on our Leopard Speech-to-Text demos for Rust, head over to our GitHub repository.

Resources