Recognize Audio Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the parameters for speech recognition of audio. "recognizeAudioParams" configuration is used in Voiceflow Modules of types "audioDialog" and "audioListener".
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
-
srEnginepropertyThe default speech recognition engine to use for recognizing speech in audio. Values:
"pocketSphinx"or"apple". Default:"pocketSphinx"if both pocketSphinx and apple speech recognizers are active and a specific engine is not requested using this property. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
languageCodepropertyThe language locale folder name created that contains the speech recognition task files or data specific to language locale used for speech recognition. Default:
"en-US". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
appleSRSessionParamspropertySpecifies the speech recognition parameters for the Apple speech recognition session.
Parameter is optional.
-
pocketSphinxSRSessionParamspropertySpecifies the speech recognition parameters for the Pocket Sphinx speech recognition session.
Parameter is optional.
-
saveUtteranceParamspropertySpecifies the parameters for saving an audio utterance.
Parameter is optional.
-
recognizeUtteranceFilepropertySpecifies whether the speech recognition task is to recognize a recorded audio utterance. Default:
"false". The value can be set at runtime using the"recognizeUtteranceFileRuntime"property.Parameter is optional.
-
recognizeUtteranceFileRuntimepropertyContains 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"recognizeUtteranceFile"property. Example:"$[RecognizeUtteranceFile]".Parameter is optional.
-
recognizeUtteranceFileParamspropertySpecifies parameters for recognizing audio in an utterance file.
Parameter is optional.
Properties
appleSRSessionParams
"appleSRSessionParams": object - AppleSRSessionParams
Discussion
Specifies the speech recognition parameters for the Apple speech recognition session.
Parameter is optional.
Declared In
Voiceflow.schema.json
languageCode
"languageCode": string
Discussion
The language locale folder name created that contains the speech recognition task files or data specific to language locale used for speech recognition. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
pocketSphinxSRSessionParams
"pocketSphinxSRSessionParams": object - PocketSphinxSRSessionParams
Discussion
Specifies the speech recognition parameters for the Pocket Sphinx speech recognition session.
Parameter is optional.
Declared In
Voiceflow.schema.json
recognizeUtteranceFile
"recognizeUtteranceFile": boolean
Discussion
Specifies whether the speech recognition task is to recognize a recorded audio utterance. Default: "false". The value can be set at runtime using the "recognizeUtteranceFileRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
recognizeUtteranceFileParams
"recognizeUtteranceFileParams": object - RecognizeUtteranceFileParams
Discussion
Specifies parameters for recognizing audio in an utterance file.
Parameter is optional.
Declared In
Voiceflow.schema.json
recognizeUtteranceFileRuntime
"recognizeUtteranceFileRuntime": 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 "recognizeUtteranceFile" property. Example: "$[RecognizeUtteranceFile]".
Parameter is optional.
Declared In
Voiceflow.schema.json
saveUtteranceParams
"saveUtteranceParams": object - SaveUtteranceParams
Discussion
Specifies the parameters for saving an audio utterance.
Parameter is optional.
Declared In
Voiceflow.schema.json
srEngine
"srEngine": string
Discussion
The default speech recognition engine to use for recognizing speech in audio. Values: "pocketSphinx" or "apple". Default: "pocketSphinx" if both pocketSphinx and apple speech recognizers are active and a specific engine is not requested using this property. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json