Class: Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/page.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#initial_prompt_fulfillment ⇒ ::Google::Cloud::Dialogflow::CX::V3::Fulfillment

Returns Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

Returns:



220
221
222
223
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 220

class FillBehavior
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#reprompt_event_handlers ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::EventHandler>

Returns 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.



220
221
222
223
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 220

class FillBehavior
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end