Module Values.IntentConfirmationSettingSource

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

Sourcetype nonrec t = {
  1. promptSpecification : PromptSpecification.t;
    (*

    Prompts the user to confirm the intent. This question should have a yes or no answer. Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

    *)
  2. declinationResponse : ResponseSpecification.t option;
    (*

    When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

    *)
  3. active : BoxedBoolean.t option;
    (*

    Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

    *)
  4. confirmationResponse : ResponseSpecification.t option;
  5. confirmationNextStep : DialogState.t option;
    (*

    Specifies the next step that the bot executes when the customer confirms the intent.

    *)
  6. confirmationConditional : ConditionalSpecification.t option;
    (*

    A list of conditional branches to evaluate after the intent is closed.

    *)
  7. declinationNextStep : DialogState.t option;
    (*

    Specifies the next step that the bot executes when the customer declines the intent.

    *)
  8. declinationConditional : ConditionalSpecification.t option;
    (*

    A list of conditional branches to evaluate after the intent is declined.

    *)
  9. failureResponse : ResponseSpecification.t option;
  10. failureNextStep : DialogState.t option;
    (*

    The next step to take in the conversation if the confirmation step fails.

    *)
  11. failureConditional : ConditionalSpecification.t option;
  12. codeHook : DialogCodeHookInvocationSetting.t option;
    (*

    The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook.

    *)
  13. elicitationCodeHook : ElicitationCodeHookInvocationSetting.t option;
    (*

    The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

    *)
}
Sourceval context_ : string
Sourceval make : ?declinationResponse:??? -> ?active:??? -> ?confirmationResponse:??? -> ?confirmationNextStep:??? -> ?confirmationConditional:??? -> ?declinationNextStep:??? -> ?declinationConditional:??? -> ?failureResponse:??? -> ?failureNextStep:??? -> ?failureConditional:??? -> ?codeHook:??? -> ?elicitationCodeHook:??? -> promptSpecification:PromptSpecification.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of BoxedBoolean.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `Enum of string | `Integer of PromptMaxRetries.t | `List of [> `Structure of (string * [> `List of [> `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `String of PlainTextMessageValue.t ]) list ]) list ] list | `String of Name.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `List of [> `Structure of (string * [> `List of [> `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `String of PlainTextMessageValue.t ]) list ]) list ] list | `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `String of PlainTextMessageValue.t ]) list ]) list ]) list ] list | `Map of ([> `String of NonEmptyString.t ] * [> `String of String_.t ]) list | `String of ConditionExpression.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `Enum of string | `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `Map of ([> `String of Name.t ] * Awso.Botodata.value) list | `String of PlainTextMessageValue.t ]) list ]) list ]) list ] list | `Map of ([> `Enum of string | `String of NonEmptyString.t ] * [> `String of String_.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `Integer of TimeInMilliSeconds.t | `Structure of (string * [> `Integer of TimeInMilliSeconds.t | `String of DTMFCharacter.t ]) list ]) list ]) list ]) list | `String of Name.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `Enum of string | `Map of ([> `String of Name.t ] * Awso.Botodata.value) list | `String of Name.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `List of [> `Structure of (string * [> `List of [> `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `String of PlainTextMessageValue.t ]) list ]) list ] list | `String of Name.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `List of [> `Structure of (string * [> `List of [> `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `String of PlainTextMessageValue.t ]) list ]) list ] list | `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `String of PlainTextMessageValue.t ]) list ]) list ]) list ] list | `Map of ([> `String of NonEmptyString.t ] * [> `String of String_.t ]) list | `String of ConditionExpression.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `Enum of string | `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `Map of ([> `String of Name.t ] * Awso.Botodata.value) list | `String of PlainTextMessageValue.t ]) list ]) list ]) list ] list | `Map of ([> `String of NonEmptyString.t ] * [> `String of String_.t ]) list | `Structure of (string * [> `Boolean of BoxedBoolean.t | `Enum of string | `Map of ([> `String of Name.t ] * Awso.Botodata.value) list | `String of Name.t | `Structure of (string * [> `Boolean of BoxedBoolean.t | `List of [> `Structure of (string * [> `List of [> `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `String of PlainTextMessageValue.t ]) list ]) list ] list | `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of ButtonText.t ]) list ] list | `String of PlainTextMessageValue.t ]) list ]) list ]) list ] list | `Map of ([> `String of NonEmptyString.t ] * [> `String of String_.t ]) list | `Structure of (string * [> `Boolean of BoxedBoolean.t | `Enum of string | `Map of ([> `String of Name.t ] * Awso.Botodata.value) list | `String of Name.t ]) list ]) list ]) list ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t