Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3Fulfillment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Fulfillment

Returns a new instance of GoogleCloudDialogflowCxV3Fulfillment.



1285
1286
1287
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1285

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#advanced_settings ⇒ Google::Apis::DialogflowV2::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

Returns:



1228
1229
1230
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1228

def advanced_settings
  @advanced_settings
end

#conditional_cases ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3FulfillmentConditionalCases>

Conditional cases for this fulfillment. Corresponds to the JSON property conditionalCases

Returns:



1233
1234
1235
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1233

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

Returns:

  • (Boolean) 


1241
1242
1243
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1241

def enable_generative_fallback
  @enable_generative_fallback
end

#generators ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings>

A list of Generators to be called during this fulfillment. Corresponds to the JSON property generators

Returns:



1247
1248
1249
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1247

def generators
  @generators
end

#messages ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3ResponseMessage>

The list of rich message responses to present to the user. Corresponds to the JSON property messages

Returns:



1252
1253
1254
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1252

def messages
  @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

Returns:

  • (Boolean) 


1263
1264
1265
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1263

def return_partial_responses
  @return_partial_responses
end

#set_parameter_actions ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3FulfillmentSetParameterAction>

Set parameter values before executing the webhook. Corresponds to the JSON property setParameterActions

Returns:



1269
1270
1271
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1269

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

Returns:

  • (String) 


1278
1279
1280
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1278

def tag
  @tag
end

#webhook ⇒ String

The webhook to call. Format: projects//locations//agents//webhooks/. Corresponds to the JSON property webhook

Returns:

  • (String) 


1283
1284
1285
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1283

def webhook
  @webhook
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 1290

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)
  @generators = args[:generators] if args.key?(:generators)
  @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