Share via


PhraseListGrammar Class

Class that allows runtime addition of phrase hints to aid in speech recognition.

Phrases added to the recognizer are effective at the start of the next recognition, or the next time the speech recognizer must reconnect to the speech service.

Note

Added in version 1.5.0.

Constructor for internal use.

Constructor

PhraseListGrammar(recognizer: Recognizer)

Parameters

Name Description
recognizer
Required

Methods

addPhrase

Adds a single phrase to the current recognizer.

clear

Clears all phrases from the current recognizer.

from_recognizer

Gets the PhraseListGrammar instance from the specified recognizer.

setWeight

Sets the phrase list grammar biasing weight. The allowed range is [0.0, 2.0]. The default weight is 1.0. Value zero disables the phrase list.

addPhrase

Adds a single phrase to the current recognizer.

addPhrase(phrase: str)

Parameters

Name Description
phrase
Required

clear

Clears all phrases from the current recognizer.

clear()

from_recognizer

Gets the PhraseListGrammar instance from the specified recognizer.

from_recognizer(recognizer: Recognizer) -> PhraseListGrammar

Parameters

Name Description
recognizer
Required

setWeight

Sets the phrase list grammar biasing weight. The allowed range is [0.0, 2.0]. The default weight is 1.0. Value zero disables the phrase list.

setWeight(weight: float)

Parameters

Name Description
weight
Required