io.spokestack.spokestack.profile

Class VADTriggerKeywordASR

java.lang.Object

io.spokestack.spokestack.profile.VADTriggerKeywordASR

All Implemented Interfaces:

PipelineProfile

public class VADTriggerKeywordASR
extends Object
implements PipelineProfile

A speech pipeline profile that uses voice activity detection to activate ASR based on keyword detection. In other words, any speech will cause the pipeline to activate, and KeywordRecognizer acts as the ASR component, only transcribing utterances contained in its vocabulary.

The activation period ends either:

• when speech stops, as determined by VoiceActivityDetector's configuration, or
• when the activation period exceeds the timeout configured in ActivationTimeout

If no valid keyword is detected during the activation period, a timeout event will be dispatched.

The components in this profile process speech entirely on the local device; no cloud components are involved.

The keyword detector requires extra configuration, which must be added to the pipeline build process separately from this profile:

• keyword-filter-path (string): file system path to the "filter" Tensorflow-Lite model
• keyword-encode-path (string): file system path to the "encode" Tensorflow-Lite model
• keyword-detect-path (string): file system path to the "detect" Tensorflow-Lite model
• keyword-metadata-path (string): file system path to the keyword model's metadata JSON file containing its classes. Required if keyword-classes is not supplied.
• keyword-classes (string): comma-separated ordered list of class names for the keywords; the name corresponding to the most likely class will be returned in the transcript field when the recognition event is raised. Required if keyword-metadata-path is not supplied.

See Also:

KeywordRecognizer

Constructor Summary

Constructors

Constructor and Description
VADTriggerKeywordASR()

Method Summary

Modifier and Type	Method and Description
SpeechPipeline.Builder	apply(SpeechPipeline.Builder builder) Apply this profile to the pipeline builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VADTriggerKeywordASR

public VADTriggerKeywordASR()

Method Detail

apply

public SpeechPipeline.Builder apply(SpeechPipeline.Builder builder)

Description copied from interface: PipelineProfile

Apply this profile to the pipeline builder.

Specified by:

apply in interface PipelineProfile

Parameters:

builder - The builder to which the profile should be applied.

Returns:

The modified pipeline builder.