Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior (v0.11.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior.

Configuration for how the filling of a parameter should be handled.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#initial_prompt_fulfillment

def initial_prompt_fulfillment() -> ::Google::Cloud::Dialogflow::CX::V3::Fulfillment
Returns

#initial_prompt_fulfillment=

def initial_prompt_fulfillment=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Fulfillment
Parameter
Returns

#reprompt_event_handlers

def reprompt_event_handlers() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>
Returns
  • (::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>) — The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:

    • sys.no-match-<N>, where N can be from 1 to 6
    • sys.no-match-default
    • sys.no-input-<N>, where N can be from 1 to 6
    • sys.no-input-default
    • sys.invalid-parameter

    initial_prompt_fulfillment provides the first prompt for the parameter.

    If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.

    A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.

    A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.

    If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

#reprompt_event_handlers=

def reprompt_event_handlers=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>
Parameter
  • value (::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>) — The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:

    • sys.no-match-<N>, where N can be from 1 to 6
    • sys.no-match-default
    • sys.no-input-<N>, where N can be from 1 to 6
    • sys.no-input-default
    • sys.invalid-parameter

    initial_prompt_fulfillment provides the first prompt for the parameter.

    If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.

    A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.

    A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.

    If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

Returns
  • (::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>) — The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:

    • sys.no-match-<N>, where N can be from 1 to 6
    • sys.no-match-default
    • sys.no-input-<N>, where N can be from 1 to 6
    • sys.no-input-default
    • sys.invalid-parameter

    initial_prompt_fulfillment provides the first prompt for the parameter.

    If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.

    A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.

    A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.

    If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.