Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Fulfillment
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Fulfillment
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb
Overview
A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.
Instance Attribute Summary collapse
-
#advanced_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
-
#conditional_cases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentConditionalCases>
Conditional cases for this fulfillment.
-
#enable_generative_fallback ⇒ Boolean
(also: #enable_generative_fallback?)
If the flag is true, the agent will utilize LLM to generate a text response.
-
#messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>
The list of rich message responses to present to the user.
-
#return_partial_responses ⇒ Boolean
(also: #return_partial_responses?)
Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs.
-
#set_parameter_actions ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentSetParameterAction>
Set parameter values before executing the webhook.
-
#tag ⇒ String
The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag
field by Dialogflow when the associated webhook is called. -
#webhook ⇒ String
The webhook to call.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Fulfillment
constructor
A new instance of GoogleCloudDialogflowCxV3Fulfillment.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Fulfillment
Returns a new instance of GoogleCloudDialogflowCxV3Fulfillment.
2911 2912 2913 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2911 def initialize(**args) update!(**args) end |
Instance Attribute Details
#advanced_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
Settings exposed at lower level overrides the settings exposed at higher level.
Overriding occurs at the sub-setting level. For example, the
playback_interruption_settings at fulfillment level only overrides the
playback_interruption_settings at the agent level, leaving other settings at
the agent level unchanged. DTMF settings does not override each other. DTMF
settings set at different levels define DTMF detections running in parallel.
Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
Corresponds to the JSON property advancedSettings
2859 2860 2861 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2859 def advanced_settings @advanced_settings end |
#conditional_cases ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentConditionalCases>
Conditional cases for this fulfillment.
Corresponds to the JSON property conditionalCases
2864 2865 2866 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2864 def conditional_cases @conditional_cases end |
#enable_generative_fallback ⇒ Boolean Also known as: enable_generative_fallback?
If the flag is true, the agent will utilize LLM to generate a text response.
If LLM generation fails, the defined responses in the fulfillment will be
respected. This flag is only useful for fulfillments associated with no-match
event handlers.
Corresponds to the JSON property enableGenerativeFallback
2872 2873 2874 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2872 def enable_generative_fallback @enable_generative_fallback end |
#messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>
The list of rich message responses to present to the user.
Corresponds to the JSON property messages
2878 2879 2880 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2878 def @messages end |
#return_partial_responses ⇒ Boolean Also known as: return_partial_responses?
Whether Dialogflow should return currently queued fulfillment response
messages in streaming APIs. If a webhook is specified, it happens before
Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API.
Responses are still queued and returned once in non-streaming API. 2) The flag
can be enabled in any fulfillment but only the first 3 partial responses will
be returned. You may only want to apply it to fulfillments that have slow
webhooks.
Corresponds to the JSON property returnPartialResponses
2889 2890 2891 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2889 def return_partial_responses @return_partial_responses end |
#set_parameter_actions ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FulfillmentSetParameterAction>
Set parameter values before executing the webhook.
Corresponds to the JSON property setParameterActions
2895 2896 2897 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2895 def set_parameter_actions @set_parameter_actions end |
#tag ⇒ String
The value of this field will be populated in the WebhookRequest
fulfillmentInfo.tag
field by Dialogflow when the associated webhook is called.
The tag is typically used by the webhook service to identify which
fulfillment is being called, but it could be used for other purposes. This
field is required if webhook
is specified.
Corresponds to the JSON property tag
2904 2905 2906 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2904 def tag @tag end |
#webhook ⇒ String
The webhook to call. Format: projects//locations//agents//webhooks/
.
Corresponds to the JSON property webhook
2909 2910 2911 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2909 def webhook @webhook end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2916 def update!(**args) @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings) @conditional_cases = args[:conditional_cases] if args.key?(:conditional_cases) @enable_generative_fallback = args[:enable_generative_fallback] if args.key?(:enable_generative_fallback) @messages = args[:messages] if args.key?(:messages) @return_partial_responses = args[:return_partial_responses] if args.key?(:return_partial_responses) @set_parameter_actions = args[:set_parameter_actions] if args.key?(:set_parameter_actions) @tag = args[:tag] if args.key?(:tag) @webhook = args[:webhook] if args.key?(:webhook) end |