pythonRhino - Python API

API Reference for the Python Rhino SDK (PyPI).


pvrhino.create()

def create(
access_key: str,
context_path: str,
library_path: Optional[str] = None,
model_path: Optional[str] = None,
sensitivity: Optional[float] = 0.5,
require_endpoint: Optional[bool] = True) -> Rhino

Factory method for Rhino Speech-to-Intent engine.

Parameters

  • access_key str : AccessKey obtained from Picovoice Console.
  • context_path str : Absolute path to file containing context model(file with .rhn extension). A context represents the set of expressions (spoken commands), intents, and intent arguments (slots) within a domain of interest.
  • library_path Optional[str] : Absolute path to Rhino's dynamic library. If not set it will be set to the default location.
  • model_path Optional[str] : Absolute path to the file containing model parameters. If not set it will be set to the default location.
  • sensitivity Optional[float] : Inference sensitivity. It should be a number within [0, 1]. A higher sensitivity value results in fewer misses at the cost of (potentially) increasing the erroneous inference rate.
  • requireEndpoint Optional[bool] : If set to False, Rhino does not require an endpoint (chunk of silence) before finishing inference.

Returns

  • Rhino: An instance of Rhino Speech-to-Intent engine.

Throws


pvrhino.Rhino

class Rhino(object)

Class for the Rhino Speech-to-Intent engine. Rhino can be initialized either using the module level create() function or directly using the class __init__() method. Resources should be cleaned when you are done using the delete() method.


pvrhino.Rhino.context_info

self.context_info: str

The context information of the Rhino instance.


pvrhino.Rhino.version

self.version: str

The version string of the Rhino library.


pvrhino.Rhino.frame_length

self.frame_length: int

The number of audio samples per frame that Rhino accepts.


pvrhino.Rhino.sample_rate

self.sample_rate: int

The audio sample rate the Rhino accepts.


pvrhino.Rhino.__init__()

def __init__(
self,
access_key: str,
library_path: str,
model_path: str,
context_path: str,
sensitivity: Optional[float] = 0.5,
require_endpoint: Optional[bool] = True) -> Rhino

__init__ method for Rhino Speech-to-Intent engine.

Parameters

  • access_key str : AccessKey obtained from Picovoice Console.
  • library_path str : Absolute path to Rhino's dynamic library.
  • model_path str : Absolute path to the file containing model parameters.
  • context_path str : Absolute path to the file containing model parameters.
  • sensitivity Optional[float] : Inference sensitivity. It should be a number within [0, 1]. A higher sensitivity value results in fewer misses at the cost of (potentially) increasing the erroneous inference rate.
  • requireEndpoint Optional[bool] : If set to False, Rhino does not require an endpoint (chunk of silence) before finishing inference.

Returns

  • Rhino: An instance of Rhino Speech-to-Intent engine.

Throws


pvrhino.Rhino.delete()

def delete(self)

Releases resources acquired by Rhino.


pvrhino.Rhino.get_inference()

def get_inference(self)

Gets inference results from Rhino. If the spoken command was understood, it includes the specific intent name that was inferred, and (if applicable) slot keys and specific slot values. Should only be called after the process function returns true, otherwise Rhino has not yet reached an inference conclusion.

Returns

  • Inference: An immutable object with .is_understood, .intent , and .slots getters.

Throws


pvrhino.Rhino.process()

def process(self, pcm: List[int]) -> bool

Processes a frame of audio and emits a flag indicating if the inference is finalized. When finalized, .get_inference() should be called to retrieve the intent and slots, if the spoken command is considered valid. The number of samples per frame can be attained by calling .frame_length. The incoming audio needs to have a sample rate equal to .sample_rate and be 16-bit linearly-encoded. Rhino operates on single-channel audio.

Parameters

  • pcm List[int] : A frame of audio samples.

Returns

  • bool : Flag indicating if the inference is finalized.

Throws


pvrhino.Rhino.Inference

Inference = namedtuple('Inference', ['is_understood', 'intent', 'slots'])

Immutable object containing Rhino inference information.

Getters

  • is_understood bool : whether Rhino understood what it heard based on the context
  • intent str : name of intent that was inferred
  • slots dict : dictionary of slot keys and values that were inferred

pvrhino.RhinoError

class RhinoError(Exception)

Error thrown if an error occurs within Rhino Speech-To-Intent engine.

Exceptions

class RhinoActivationError(RhinoError)
class RhinoActivationLimitError(RhinoError)
class RhinoActivationRefusedError(RhinoError)
class RhinoActivationThrottledError(RhinoError)
class RhinoIOError(RhinoError)
class RhinoInvalidArgumentError(RhinoError)
class RhinoInvalidStateError(RhinoError)
class RhinoKeyError(RhinoError)
class RhinoMemoryError(RhinoError)
class RhinoRuntimeError(RhinoError)
class RhinoStopIterationError(RhinoError)

Issue with this doc? Please let us know.