Recognize Utterance File Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies parameters for recognizing audio in an utterance file.
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
-
utteranceFileNamepropertyFile name that contains the recorded audio utterance to be sent to a speech recognizer. The value can be set at runtime using
"$[<FieldName>]"entry convention.Parameter is optional.
-
utteranceFileLocationpropertyURL or location of folder where
"utteranceFileName"containing the recorded audio utterance is located. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
offlineModepropertySpecifies whether the speech recognition task will be executed in offline mode which means a recorded audio utterance will be sent in large blocks to the speech recognizer or will be sent in streaming small packets similar to live streaming from a user. Default:
"false". The value can be set at runtime using the"offlineModeRuntime"property.Parameter is optional.
-
offlineModeRuntimepropertyContains 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"offlineMode"property. Example:"$[OfflineMode]".Parameter is optional.
-
startPosMspropertyTime position in milliseconds in a recorded audio utterance to start speech recognition from. Default: 0. The value can be set at runtime using the
"startPosMsRuntime"property.Parameter is optional.
-
startPosMsRuntimepropertyContains 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"startPosMs"property. Example:"$[StartPosMs]".Parameter is optional.
-
stopPosMspropertyTime position in milliseconds in a recorded audio utterance to stop speech recognition at. Default: 0. The value can be set at runtime using the
"stopPosMsRuntime"property.Parameter is optional.
-
stopPosMsRuntimepropertyContains 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"stopPosMs"property. Example:"$[StopPosMs]".Parameter is optional.
-
audioFormatpropertyAudio format of raw audio. Use if audio format from source is not available or cannot be automatically detected. Values:
"pcm_8khz","pcm_16khz","pcm_32khz","pcm_48khz","wav","compressed"(experimental),"preencoded"(experimental),"media", or"raw". Default:"pcm_16khz". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
audioCodecproperty(Experimental) The audio codec parameters to use for audio playback and audio recording if one is not specified or supported in
"audioFormat"property. Example:"payloadType": 93,"payloadName":"L16","payloadFrequency": 16000,"audioPacketSizeBytes": 160,"numberChannelsPerAudioSample": 1,"sampleRateBitsPerSecond": 256000.Parameter is optional.
Properties
audioCodec
"audioCodec": object - AudioCodec
Discussion
(Experimental) The audio codec parameters to use for audio playback and audio recording if one is not specified or supported in "audioFormat" property. Example: "payloadType": 93, "payloadName": "L16", "payloadFrequency": 16000, "audioPacketSizeBytes": 160, "numberChannelsPerAudioSample": 1, "sampleRateBitsPerSecond": 256000.
Parameter is optional.
Declared In
Voiceflow.schema.json
audioFormat
"audioFormat": string
Discussion
Audio format of raw audio. Use if audio format from source is not available or cannot be automatically detected. Values: "pcm_8khz", "pcm_16khz", "pcm_32khz", "pcm_48khz", "wav", "compressed" (experimental), "preencoded" (experimental), "media", or "raw". Default: "pcm_16khz". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
offlineMode
"offlineMode": boolean
Discussion
Specifies whether the speech recognition task will be executed in offline mode which means a recorded audio utterance will be sent in large blocks to the speech recognizer or will be sent in streaming small packets similar to live streaming from a user. Default: "false". The value can be set at runtime using the "offlineModeRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
offlineModeRuntime
"offlineModeRuntime": 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 "offlineMode" property. Example: "$[OfflineMode]".
Parameter is optional.
Declared In
Voiceflow.schema.json
startPosMs
"startPosMs": integer
Discussion
Time position in milliseconds in a recorded audio utterance to start speech recognition from. Default: 0. The value can be set at runtime using the "startPosMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
startPosMsRuntime
"startPosMsRuntime": 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 "startPosMs" property. Example: "$[StartPosMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json
stopPosMs
"stopPosMs": integer
Discussion
Time position in milliseconds in a recorded audio utterance to stop speech recognition at. Default: 0. The value can be set at runtime using the "stopPosMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
stopPosMsRuntime
"stopPosMsRuntime": 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 "stopPosMs" property. Example: "$[StopPosMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json