Rhino Speech-to-Intent
.NET API

API Reference for the .NET Rhino SDK (NuGet)

namespace: Pv

Rhino

public class Rhino : IDisposable { }

Class for the Rhino Speech-To-Intent engine.

Rhino.Create()

public static Rhino Create(
    string accessKey,
    string contextPath,
    string modelPath = null,
    float sensitivity = 0.5f,
    float endpointDurationSec = 1.0f,
    bool requireEndpoint = true)

Rhino constructor.

Parameters

• accessKey string : AccessKey obtained from Picovoice Console.
• contextPath string : Absolute path to file containing context parameters (.rhn).
• modelPath string : Absolute path to the file containing model parameters (.pv).
• sensitivity float : Inference sensitivity. It should be a number within [0, 1].
• endpointDurationSec float : Endpoint duration in seconds. An endpoint is a chunk of silence at the end of an utterance that marks the end of spoken command. It should be a positive number within [0.5, 5]. A lower endpoint duration reduces delay and improves responsiveness. A higher endpoint duration assures Rhino doesn't return inference pre-emptively in case the user pauses before finishing the request.
• requireEndpoint bool : If set to true, Rhino requires an endpoint (a chunk of silence) after the spoken command. If set to false, Rhino tries to detect silence, but if it cannot, it still will provide inference regardless. Set to false only if operating in an environment with overlapping speech (e.g. people talking in the background).

Returns

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

Throws

• RhinoException: If an error occurs while creating an instance of the Rhino Speech-To-Intent engine.

Rhino.Process()

public bool Process(short[] pcm)

Processes a frame of the incoming audio stream and emits the detection result. The number of samples per frame can be attained by calling .FrameLength. The incoming audio needs to have a sample rate equal to .SampleRate and be 16-bit linearly-encoded. Rhino operates on single-channel audio.

Parameters

• pcm short[] : A frame of audio samples.

Returns

• bool: Flag indicating whether the engine has finalized intent extraction.

Throws

• RhinoException: If there is an error while processing the audio frame.

Rhino.Reset()

public void Reset()

Resets the internal state of Rhino. It should be called before the engine can be used to infer intent from a new stream of audio.

Throws

• RhinoException: If there is an error while resetting.

Rhino.GetInference()

public Inference GetInference()

Gets inference result. 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

• RhinoInference: The result of inference.

Throws

• RhinoException: If inference retrieval fails.

Rhino.ContextInfo

public string ContextInfo { get; private set; }

Getter for context information.

Returns

• string: Returns the context information.

Rhino.FrameLength

public int FrameLength { get; private set; }

Getter for number of audio samples per frame.

Returns

• int: Number of audio samples per frame.

Rhino.SampleRate

public int SampleRate { get; private set; }

Getter for audio sample rate accepted by Picovoice.

Returns

• int: Audio sample rate accepted by Picovoice.

Rhino.Version

public string Version { get; private set; }

Getter for version.

Returns

• string: Current Rhino version.

Inference

public class Inference { }

Class for holding Rhino inference result.

Inference.IsUnderstood

public bool IsUnderstood { get; }

Getter for IsUnderstood.

Returns

• bool: Whether Rhino understood what it heard based on the context.

Inference.Intent

public string Intent { get; }

Getter for Intent.

Returns

• string: Name of intent that was inferred.

Inference.Slots

public Dictionary<string, string> Slots { get; }

Getter for Slots.

Returns

• Dictionary<string, string>: Map of inference slots and values.

RhinoException

public class RhinoException extends Exception { }

Exception thrown if an error occurs within the Rhino engine.

Exceptions:

public class RhinoActivationException           extends RhinoException { }
public class RhinoActivationLimitException      extends RhinoException { }
public class RhinoActivationRefusedException    extends RhinoException { }
public class RhinoActivationThrottledException  extends RhinoException { }
public class RhinoIOException                   extends RhinoException { }
public class RhinoInvalidArgumentException      extends RhinoException { }
public class RhinoInvalidStateException         extends RhinoException { }
public class RhinoKeyException                  extends RhinoException { }
public class RhinoMemoryException               extends RhinoException { }
public class RhinoRuntimeException              extends RhinoException { }
public class RhinoStopIterationException        extends RhinoException { }