Declared in Voiceflow.schema.json

Overview

Specifies the parameters for speech recognition of audio. "recognizeAudioParams" configuration is used in Voiceflow Modules of types "recognizeAudio", "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.

Properties

  •   srEngine

    The default speech recognition engine to use for recognizing speech in audio. Currently only "apple" speech recognition engint is supported. Values: . Default: "apple". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   srLocale

    The language locale for the speech recognition engine to use. This allows multi-lingual speech recognition. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   srSessionParams

    Specifies the speech recognition parameters for the speech recognition session.

    Parameter is optional.

           json parameter
  •   recordUtteranceAudio

    Specifies whether or not to record utterance audio to a file. Default: "false". The value can be set at runtime using the "recordUtteranceAudioRuntime" property.

    Parameter is optional.

           json parameter
  •   recordUtteranceAudioRuntime

    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 "recordUtteranceAudio" property. Example: "$[RecordUtteranceAudio]".

    Parameter is optional.

           json parameter
  •   recognizeUtteranceFile

    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.

           json parameter
  •   recognizeUtteranceFileRuntime

    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.

           json parameter
  •   recognizeUtteranceFileParams

    Specifies parameters for recognizing audio in an utterance file.

    Parameter is optional.

           json parameter

JSON Parameters

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

recordUtteranceAudio

"recordUtteranceAudio": boolean

Discussion

Specifies whether or not to record utterance audio to a file. Default: "false". The value can be set at runtime using the "recordUtteranceAudioRuntime" property.

Parameter is optional.

Declared In

Voiceflow.schema.json

recordUtteranceAudioRuntime

"recordUtteranceAudioRuntime": 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 "recordUtteranceAudio" property. Example: "$[RecordUtteranceAudio]".

Parameter is optional.

Declared In

Voiceflow.schema.json

srEngine

"srEngine": string

Discussion

The default speech recognition engine to use for recognizing speech in audio. Currently only "apple" speech recognition engint is supported. Values: . Default: "apple". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

srLocale

"srLocale": string

Discussion

The language locale for the speech recognition engine to use. This allows multi-lingual speech recognition. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

srSessionParams

"srSessionParams": object - srSessionParams

Discussion

Specifies the speech recognition parameters for the speech recognition session.

Parameter is optional.

Declared In

Voiceflow.schema.json