pythonRhino - 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)
  • BeagleBone
  • NVIDIA Jetson Nano
  • Raspberry Pi (Zero, 2, 3, 4)

Requirements

Picovoice Account & AccessKey

  1. Login or signup for a free account on the Picovoice Console.
  2. Go to the AccessKey tab to create one or use an existing AccessKey. Be 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:

rhino.delete()

Custom Contexts

Create custom context using the Picovoice Console. Download the custom context file (.rhn) and create an instance of Rhino 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 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 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 pvrhinodeemo

This package installs command-line utilities for the Rhino 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 demos for Python, head over to our GitHub repository.

Resources

Packages

API

GitHub


Issue with this doc? Please let us know.