Rhino Speech-to-Intent
Python Quick Start

This document outlines how to integrate Rhino Speech-to-Intent engine within an application using its Python API.

Platforms

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

Requirements

• Picovoice Account & AccessKey
• Python 3.9+
• PIP

Picovoice Account & AccessKey

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

Quick Start

Setup

1. Install Python 3.

2. Install the pvrhino Python package using PIP:

pip3 install pvrhino

Usage

Create an instance of Rhino Speech-to-Intent engine that infers intent from spoken commands within a given context:

import pvrhino

rhino = pvrhino.create(
   access_key='${ACCESS_KEY}',
   context_path='${CONTEXT_FILE_PATH}'
)

Pass in frames of audio to the .process function and use the .get_inference function:

def get_next_audio_frame():
    pass

while True:
   audio_frame = get_next_audio_frame()
   is_finalized = rhino.process(audio_frame)
   if is_finalized:
      # get inference if is_finalized is true
      inference = rhino.get_inference()
      if inference.is_understood:
         # use intent and slots if inference was understood
         intent = inference.intent
         slots = inference.slots

Release resources explicitly when done with Rhino Speech-to-Intent:

rhino.delete()

Custom Contexts

Create custom context using the Picovoice Console. Download the custom context file (.rhn) and create an instance of Rhino Speech-to-Intent using the context_path input argument:

rhino = pvrhino.create(
   access_key='${ACCESS_KEY}',
   context_path='${CONTEXT_FILE_PATH}'
)

Non-English Languages

Use the corresponding model file (.pv), to detect non-English contexts. The model files for all supported languages are available on the Rhino Speech-to-Intent GitHub repository.

Pass in the model file using the model_path input argument to change the detection language:

rhino = pvrhino.create(
   access_key='${ACCESS_KEY}',
   context_path='${CONTEXT_FILE_PATH}',
   model_path='${MODEL_FILE_PATH}'
)

Demo

For the Rhino Speech-to-Intent Python SDK, we offer demo applications that demonstrate how to use the Speech-to-Intent engine on real-time audio streams (i.e. microphone input) and audio files.

Setup

Install the pvrhinodemo Python package using PIP:

pip3 install pvrhinodemo

This package installs command-line utilities for the Rhino Speech-to-Intent Python demos.

Usage

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

rhino_demo_mic --help

Ensure you have a working microphone connected to your system and run the following command to infer intent from spoken commands:

rhino_demo_mic --access_key ${ACCESS_KEY} --context_path ${CONTEXT_FILE_PATH}

For more information on our Rhino Speech-to-Intent demos for Python, head over to our GitHub repository.

Resources