Declared in Voiceflow.schema.json

Overview

Specifies custom contextual string dictionaries to be sent to speech recognizer for more accurate speech recognition.

Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.

Properties

  •   loadContextualDictionary

    Specifies whether to have the speech recognizer load the contextual dictionary for more accurate speech recognotion of specific vocabulary. Default: "false". The value can be set at runtime using the "loadContextualDictionaryRuntime" property.

    Parameter is optional.

           json parameter
  •   loadContextualDictionaryRuntime

    Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "loadContextualDictionary" property. Example: "$[LoadContextualDictionary]".

    Parameter is optional.

           json parameter
  •   contextualDictionaryEntryList

    An array of contextual string to phonetic map entries that are sent to speech recognizer for more accurate speech recognition of specific vocabulary.

    Parameter is optional.

           json parameter
  •   contextualDictionaryFileName

    Specifies the file name that contains a list of contextual strings to phonetic map pairs. The phonetic map can contain multiple entries separated by "|". The value can be set at runtime using "$[<FieldName>]" entry convention.
    The entries in the Context Dictionary file file should confirm to the following entry style:

    Quvenzhané: Kwuh-ven-zha-nay
Xóchitl: So-cheel
#Saoirse: Sur-sha
Meemzee: Meam-zee|Mimzy

    Parameter is optional.

           json parameter
  •   contextualDictionaryFileLocation

    Specifies the location path of the file containing the list of contextual strings to phonetic map pairs. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter

JSON Parameters

contextualDictionaryEntryList

"contextualDictionaryEntryList": array - [contextualStringToPhoneticMap]

Discussion

An array of contextual string to phonetic map entries that are sent to speech recognizer for more accurate speech recognition of specific vocabulary.

Parameter is optional.

Declared In

Voiceflow.schema.json

contextualDictionaryFileLocation

"contextualDictionaryFileLocation": string

Discussion

Specifies the location path of the file containing the list of contextual strings to phonetic map pairs. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

contextualDictionaryFileName

"contextualDictionaryFileName": string

Discussion

Specifies the file name that contains a list of contextual strings to phonetic map pairs. The phonetic map can contain multiple entries separated by "|". The value can be set at runtime using "$[<FieldName>]" entry convention.
The entries in the Context Dictionary file file should confirm to the following entry style:

Quvenzhané: Kwuh-ven-zha-nay
Xóchitl: So-cheel
#Saoirse: Sur-sha
Meemzee: Meam-zee|Mimzy

Parameter is optional.

Declared In

Voiceflow.schema.json

loadContextualDictionary

"loadContextualDictionary": boolean

Discussion

Specifies whether to have the speech recognizer load the contextual dictionary for more accurate speech recognotion of specific vocabulary. Default: "false". The value can be set at runtime using the "loadContextualDictionaryRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

loadContextualDictionaryRuntime

"loadContextualDictionaryRuntime": string

Discussion

Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "loadContextualDictionary" property. Example: "$[LoadContextualDictionary]".

Parameter is optional.

Declared In

Voiceflow.schema.json