Declared in Voiceflow.schema.json

Overview

Specifies the next Voiceflow Module ID to transition to if a speech hypothesis compares and matches to an entry from list of valid user inputs.

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

  •   enablePartialSRHypothsis

    Specifies whether comparing partial SR hypotheses to entries in a valid user input list is enabled. Default: "false". The value cannot be set at runtime.

    Parameter is optional.

           json parameter
  •   comparator

    Specifies type of comparison executed between SR hypothesis and entries in a valid user input list. Values: "equals", "starts", or "contains". Default: "equals". SR Hypothesis is compared to determine if it equals, starts with or contains an entry in a valid user input list. Comparisons are case insensitive. The value cannot be set at runtime.

    Parameter is optional.

           json parameter
  •   input

    specifies an entry from a valid user input list. The value cannot be set at runtime.

    Parameter is required.

           json parameter
  •   goTo

    Specifies the Voice Module ID to transition to if comparing speech hypothesis to value of "input" results in a match. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is required.

           json parameter

JSON Parameters

comparator

"comparator": string

Discussion

Specifies type of comparison executed between SR hypothesis and entries in a valid user input list. Values: "equals", "starts", or "contains". Default: "equals". SR Hypothesis is compared to determine if it equals, starts with or contains an entry in a valid user input list. Comparisons are case insensitive. The value cannot be set at runtime.

Parameter is optional.

Declared In

Voiceflow.schema.json

enablePartialSRHypothsis

"enablePartialSRHypothsis": boolean

Discussion

Specifies whether comparing partial SR hypotheses to entries in a valid user input list is enabled. Default: "false". The value cannot be set at runtime.

Parameter is optional.

Declared In

Voiceflow.schema.json

goTo

"goTo": string

Discussion

Specifies the Voice Module ID to transition to if comparing speech hypothesis to value of "input" results in a match. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is required.

Declared In

Voiceflow.schema.json

input

"input": string

Discussion

specifies an entry from a valid user input list. The value cannot be set at runtime.

Parameter is required.

Declared In

Voiceflow.schema.json