Interface ListeningOptions

Provides the configuration for the audio input processing output. This can either include NLP processing using the (nlpModels) or directly retrieving the transcription. speechContext provides the ability to further improve the transcription accuracy given an assumed context.

Example

var options = VoiceML.ListeningOptions.create();
var nlpKeywordModel = VoiceML.NlpKeywordModelOptions.create();
nlpKeywordModel.addKeywordGroup("fruit", ["orange", "apple"]);
nlpKeywordModel.addKeywordGroup("vegetable", ["carrot", "tomato"]);

var nlpIntentsModel = VoiceML.NlpIntentsModelOptions.create("VOICE_ENABLED_UI"); 
nlpIntentsModel.possibleIntents = []; 

var nlpIntentsModel2 = VoiceML.NlpIntentsModelOptions.create("VOICE_ENABLED_UI");
nlpIntentsModel2.possibleIntents = ["next", "back"];

options.nlpModels = [ nlpIntentsModel, nlpKeywordModel, nlpIntentsModel2];

options.addSpeechContext(["orange", "apple"], 2);
options.speechRecognizer = VoiceMLModule.SpeechRecognizer.Default;
interface ListeningOptions {
    languageCode: string;
    nlpModels: BaseNlpModel[];
    postProcessingActions: PostProcessingAction[];
    shouldReturnAsrTranscription: boolean;
    shouldReturnInterimAsrTranscription: boolean;
    speechContexts: SpeechContext[];
    speechRecognizer: string;
    addSpeechContext(phrases: string[], boost: number): void;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

languageCode nlpModels postProcessingActions shouldReturnAsrTranscription shouldReturnInterimAsrTranscription speechContexts speechRecognizer

Methods

addSpeechContext getTypeName isOfType isSame

Properties

languageCode

languageCode: string

The language which VoiceML should listen to.

nlpModels

nlpModels: BaseNlpModel[]

Options for the ML model to be used.

postProcessingActions

postProcessingActions: PostProcessingAction[]

An array of VoiceML.QnaAction elements. It is used to pass the context in each QnaAction to the DialogML.

shouldReturnAsrTranscription

shouldReturnAsrTranscription: boolean

Should complete transcription returned. Such transcriptions after the user stopped speaking. This transcription is marked with isFinalTranscription=true in the OnListeningUpdate.

shouldReturnInterimAsrTranscription

shouldReturnInterimAsrTranscription: boolean

Should interim transcription returned. Such transcriptions are returned while the user still speaks, however they may be less accurate, and can be changed on following transcriptions. This interim results are marked with isFinalTranscription=false in the OnListeningUpdate.

speechContexts

speechContexts: SpeechContext[]

Supports multiple speech contexts for increased transcription accuracy.

speechRecognizer

speechRecognizer: string

An optional attribute to specify which speech recognizer ML model to use when transcribing. When creating a new ListeningOptions the value of this attrbute is defaulted to SPEECH_RECOGNIZER. The supported values are: SPEECH_RECOGNIZER.

Methods

addSpeechContext

  • addSpeechContext(phrases, boost): void

  • In cases where specific words are expected from the users, the transcription accuracy of these words can be improved, by strengthening their likelihood in context. The strength is scaled 1-10 (10 being the strongest increase) the default value is 5.

    Parameters

    • phrases: string[]
    • boost: number

    Returns void

getTypeName

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods