Declared in Voiceflow.schema.json

Overview

Specifies parameters for recognizing audio from 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.

Properties

  •   utteranceFileName

    File 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.

           json parameter
  •   utteranceFileLocation

    URL 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.

           json parameter
  •   offlineMode

    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 device streaming from a user. Default: "false". The value can be set at runtime using the "offlineModeRuntime" property.

    Parameter is optional.

           json parameter
  •   offlineModeRuntime

    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.

           json parameter

JSON Parameters

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 device 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

utteranceFileLocation

"utteranceFileLocation": string

Discussion

URL 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.

Declared In

Voiceflow.schema.json

utteranceFileName

"utteranceFileName": string

Discussion

File 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.

Declared In

Voiceflow.schema.json