Dialog Prompt JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies Audio Prompt Module groups that define all audio playbacks throughout the execution of an interactive dialog.
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
-
typepropertySpecifies the type of the Audio Prompt group. Values:
"preInitial","initial","garbage","timeout", or"sr_error". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
stylepropertySpecifies the style, method or sequence of selecting an Audio Prompt Module configured in an Audio Prompt Module group. Values:
"single","select","combo", or"serial". Default:"combo". The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
recognizeWhilePlaypropertySpecifies if speech recognition is active during audio playback so User can barge-in instead of speech recognition starting after audio playback ends. Default:
"false". The value can be set at runtime using the"recognizeWhilePlayRuntime"property.Parameter is optional.
-
recognizeWhilePlayRuntimepropertyContains 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"recognizeWhilePlay"property. Example:"$[RecognizeWhilePlay]".Parameter is optional.
-
playInitialAfterpropertySpecifies whether the
"initial"type Audio Prompt Module group will be re-processed for audio playback after"garbage","timeout"or"sr_error"type Audio Prompt Module group has completed its processing for audio playback. Default:"false". The value can be set at runtime using the"playInitialAfterRuntime"property.Parameter is optional.
-
playInitialAfterRuntimepropertyContains 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"playInitialAfter"property. Example:"$[PlayInitialAfter]".Parameter is optional.
-
promptIDpropertyID of Audio Prompt Module to process for audio playback. The value can be set at runtime using
"$[<FieldName>]"entry convention.Parameter is optional.
-
promptCollectionpropertySpecifies an array of Audio Prompt Module IDs to be processed for audio playback according to the
"style"of the Audio Prompt Module group.Parameter is optional.
Properties
playInitialAfter
"playInitialAfter": boolean
Discussion
Specifies whether the "initial" type Audio Prompt Module group will be re-processed for audio playback after "garbage", "timeout" or "sr_error" type Audio Prompt Module group has completed its processing for audio playback. Default: "false". The value can be set at runtime using the "playInitialAfterRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
playInitialAfterRuntime
"playInitialAfterRuntime": 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 "playInitialAfter" property. Example: "$[PlayInitialAfter]".
Parameter is optional.
Declared In
Voiceflow.schema.json
promptCollection
"promptCollection": array - [Prompt]
Discussion
Specifies an array of Audio Prompt Module IDs to be processed for audio playback according to the "style" of the Audio Prompt Module group.
Parameter is optional.
Declared In
Voiceflow.schema.json
promptID
"promptID": string
Discussion
ID of Audio Prompt Module to process for audio playback. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
recognizeWhilePlay
"recognizeWhilePlay": boolean
Discussion
Specifies if speech recognition is active during audio playback so User can barge-in instead of speech recognition starting after audio playback ends. Default: "false". The value can be set at runtime using the "recognizeWhilePlayRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
recognizeWhilePlayRuntime
"recognizeWhilePlayRuntime": 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 "recognizeWhilePlay" property. Example: "$[RecognizeWhilePlay]".
Parameter is optional.
Declared In
Voiceflow.schema.json
style
"style": string
Discussion
Specifies the style, method or sequence of selecting an Audio Prompt Module configured in an Audio Prompt Module group. Values: "single", "select", "combo", or "serial". Default: "combo". The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json