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

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

Represents a form parameter.

Defined Under Namespace

Classes: FillBehavior

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Returns Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 177

class Parameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for how the filling of a parameter should be handled.
  # @!attribute [rw] initial_prompt_fulfillment
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
  #     Required. The fulfillment to provide the initial prompt that the agent
  #     can present to the user in order to fill the parameter.
  # @!attribute [rw] reprompt_event_handlers
  #   @return [::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.
  class FillBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#default_value ⇒ ::Google::Protobuf::Value

Returns The default value of an optional parameter. If the parameter is required, the default value will be ignored.

Returns:

  • (::Google::Protobuf::Value) —

    The default value of an optional parameter. If the parameter is required, the default value will be ignored.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 177

class Parameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for how the filling of a parameter should be handled.
  # @!attribute [rw] initial_prompt_fulfillment
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
  #     Required. The fulfillment to provide the initial prompt that the agent
  #     can present to the user in order to fill the parameter.
  # @!attribute [rw] reprompt_event_handlers
  #   @return [::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.
  class FillBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the parameter, unique within the form.

Returns:

  • (::String) —

    Required. The human-readable name of the parameter, unique within the form.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 177

class Parameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for how the filling of a parameter should be handled.
  # @!attribute [rw] initial_prompt_fulfillment
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
  #     Required. The fulfillment to provide the initial prompt that the agent
  #     can present to the user in order to fill the parameter.
  # @!attribute [rw] reprompt_event_handlers
  #   @return [::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.
  class FillBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#entity_type ⇒ ::String

Returns Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID> for developer entity types.

Returns:

  • (::String) —

    Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID> for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID> for developer entity types.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 177

class Parameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for how the filling of a parameter should be handled.
  # @!attribute [rw] initial_prompt_fulfillment
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
  #     Required. The fulfillment to provide the initial prompt that the agent
  #     can present to the user in order to fill the parameter.
  # @!attribute [rw] reprompt_event_handlers
  #   @return [::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.
  class FillBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#fill_behavior ⇒ ::Google::Cloud::Dialogflow::CX::V3::Form::Parameter::FillBehavior

Returns Required. Defines fill behavior for the parameter.

Returns:



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 177

class Parameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for how the filling of a parameter should be handled.
  # @!attribute [rw] initial_prompt_fulfillment
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
  #     Required. The fulfillment to provide the initial prompt that the agent
  #     can present to the user in order to fill the parameter.
  # @!attribute [rw] reprompt_event_handlers
  #   @return [::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.
  class FillBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#is_list ⇒ ::Boolean

Returns Indicates whether the parameter represents a list of values.

Returns:

  • (::Boolean) —

    Indicates whether the parameter represents a list of values.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 177

class Parameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for how the filling of a parameter should be handled.
  # @!attribute [rw] initial_prompt_fulfillment
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
  #     Required. The fulfillment to provide the initial prompt that the agent
  #     can present to the user in order to fill the parameter.
  # @!attribute [rw] reprompt_event_handlers
  #   @return [::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.
  class FillBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#redact ⇒ ::Boolean

Returns Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or [entity type level redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.

Returns:

  • (::Boolean) —

    Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or [entity type level redaction][google.cloud.dialogflow.cx.v3.EntityType.redact] is enabled.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 177

class Parameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for how the filling of a parameter should be handled.
  # @!attribute [rw] initial_prompt_fulfillment
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
  #     Required. The fulfillment to provide the initial prompt that the agent
  #     can present to the user in order to fill the parameter.
  # @!attribute [rw] reprompt_event_handlers
  #   @return [::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.
  class FillBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#required ⇒ ::Boolean

Returns Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

Returns:

  • (::Boolean) —

    Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 177

class Parameter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration for how the filling of a parameter should be handled.
  # @!attribute [rw] initial_prompt_fulfillment
  #   @return [::Google::Cloud::Dialogflow::CX::V3::Fulfillment]
  #     Required. The fulfillment to provide the initial prompt that the agent
  #     can present to the user in order to fill the parameter.
  # @!attribute [rw] reprompt_event_handlers
  #   @return [::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.
  class FillBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end