Pocket Sphinx SR Session Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the speech recognition parameters for the Pocket Sphinx speech recognition session.
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.
Tasks
-
reloadTaskpropertySpecifies whether Pocket Sphinx reloads a task that was already loaded. Default:
"false". The value can be set at runtime using the"reloadTaskRuntime"property.Parameter is optional.
-
reloadTaskRuntimepropertyContains 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"reloadTask"property. Example:"$[ReloadTask]".Parameter is optional.
-
enableContinuousSRpropertySpecifies whether Pocket Sphinx speech recognition executes in continuous mode. Default:
"false". The value can be set at runtime using the"enableContinuousSRRuntime"property.Parameter is optional.
-
enableContinuousSRRuntimepropertyContains 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"enableContinuousSR"property. Example:"$[EnableContinuousSR]".Parameter is optional.
-
enablePartialResultspropertySpecifies whether Pocket Sphinx recognizer returns intermediate results for each utterance. Default:
"false". The value can be set at runtime using the"enablePartialResultsRuntime"property.Parameter is optional.
-
enablePartialResultsRuntimepropertyContains 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"enablePartialResults"property. Example:"$[EnablePartialResults]".Parameter is optional.
-
nBestCountpropertySpecifies the number of speech recognition candidates for Pocket Sphinx recognizer to produce. Default: 1. Maximum is 4. The value can be set at runtime using the
"nBestCountRuntime"property.Parameter is optional.
-
nBestCountRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"nBestCount"property. Example:"$[NBestCount]".Parameter is optional.
-
pocketSphinxSRTaskpropertySpeech recognition task for Pocket Sphinx to load.
Parameter is optional.
-
pocketSphinxSRCustomDictionarypropertySpecifies custom dictionaries to be sent to Pocket Sphinx speech recognizer for more accurate speech recognition.
Parameter is optional.
Properties
enableContinuousSR
"enableContinuousSR": boolean
Discussion
Specifies whether Pocket Sphinx speech recognition executes in continuous mode. Default: "false". The value can be set at runtime using the "enableContinuousSRRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableContinuousSRRuntime
"ienableContinuousSRRuntimed": 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 "enableContinuousSR" property. Example: "$[EnableContinuousSR]".
Parameter is optional.
Declared In
Voiceflow.schema.json
enablePartialResults
"enablePartialResults": boolean
Discussion
Specifies whether Pocket Sphinx recognizer returns intermediate results for each utterance. Default: "false". The value can be set at runtime using the "enablePartialResultsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enablePartialResultsRuntime
"enablePartialResultsRuntime": 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 "enablePartialResults" property. Example: "$[EnablePartialResults]".
Parameter is optional.
Declared In
Voiceflow.schema.json
nBestCount
"nBestCount": integer
Discussion
Specifies the number of speech recognition candidates for Pocket Sphinx recognizer to produce. Default: 1. Maximum is 4. The value can be set at runtime using the "nBestCountRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
nBestCountRuntime
"nBestCountRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "nBestCount" property. Example: "$[NBestCount]".
Parameter is optional.
Declared In
Voiceflow.schema.json
pocketSphinxSRCustomDictionary
"pocketSphinxSRCustomDictionary": object - PocketSphinxSRCustomDictionary
Discussion
Specifies custom dictionaries to be sent to Pocket Sphinx speech recognizer for more accurate speech recognition.
Parameter is optional.
Declared In
Voiceflow.schema.json
pocketSphinxSRTask
"pocketSphinxSRTask": object - PocketSphinxSRTask
Discussion
Speech recognition task for Pocket Sphinx to load.
Parameter is optional.
Declared In
Voiceflow.schema.json
reloadTask
"reloadTask": boolean
Discussion
Specifies whether Pocket Sphinx reloads a task that was already loaded. Default: "false". The value can be set at runtime using the "reloadTaskRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
reloadTaskRuntime
"reloadTaskRuntime": 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 "reloadTask" property. Example: "$[ReloadTask]".
Parameter is optional.
Declared In
Voiceflow.schema.json