Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v2/classes.rb,
generated/google/apis/dialogflow_v2/representations.rb,
generated/google/apis/dialogflow_v2/representations.rb

Overview

Corresponds to the Response field in the Dialogflow console.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1IntentMessage

Returns a new instance of GoogleCloudDialogflowV2beta1IntentMessage.



4321
4322
4323
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4321

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

Instance Attribute Details

#basic_card ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageBasicCard

The basic card message. Useful for displaying information. Corresponds to the JSON property basicCard

Returns:



4194
4195
4196
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4194

def basic_card
  @basic_card
end

#browse_carousel_card ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard

Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel Corresponds to the JSON property browseCarouselCard

Returns:



4200
4201
4202
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4200

def browse_carousel_card
  @browse_carousel_card
end

#card ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageCard

The card response message. Corresponds to the JSON property card

Returns:



4205
4206
4207
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4205

def card
  @card
end

#carousel_select ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect

The card for presenting a carousel of options to select from. Corresponds to the JSON property carouselSelect

Returns:



4210
4211
4212
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4210

def carousel_select
  @carousel_select
end

#image ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage

The image response message. Corresponds to the JSON property image

Returns:



4215
4216
4217
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4215

def image
  @image
end

#link_out_suggestion ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion

The suggestion chip message that allows the user to jump out to the app or website associated with this agent. Corresponds to the JSON property linkOutSuggestion

Returns:



4221
4222
4223
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4221

def link_out_suggestion
  @link_out_suggestion
end

#list_select ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageListSelect

The card for presenting a list of options to select from. Corresponds to the JSON property listSelect

Returns:



4226
4227
4228
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4226

def list_select
  @list_select
end

#media_content ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageMediaContent

The media content card for Actions on Google. Corresponds to the JSON property mediaContent

Returns:



4231
4232
4233
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4231

def media_content
  @media_content
end

#payload ⇒ Hash<String,Object>

Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform. Corresponds to the JSON property payload

Returns:

  • (Hash<String,Object>) 


4238
4239
4240
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4238

def payload
  @payload
end

#platform ⇒ String

Optional. The platform that this message is intended for. Corresponds to the JSON property platform

Returns:

  • (String) 


4243
4244
4245
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4243

def platform
  @platform
end

#quick_replies ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageQuickReplies

The quick replies response message. Corresponds to the JSON property quickReplies

Returns:



4248
4249
4250
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4248

def quick_replies
  @quick_replies
end

#rbm_carousel_rich_card ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard

Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. For more details about RBM rich cards, please see: https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- messages#rich-cards. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. Corresponds to the JSON property rbmCarouselRichCard

Returns:



4260
4261
4262
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4260

def rbm_carousel_rich_card
  @rbm_carousel_rich_card
end

#rbm_standalone_rich_card ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard

Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. For more details about RBM rich cards, please see: https://developers.google.com/rcs-business-messaging/rbm/guides/build/send- messages#rich-cards. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. Corresponds to the JSON property rbmStandaloneRichCard

Returns:



4272
4273
4274
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4272

def rbm_standalone_rich_card
  @rbm_standalone_rich_card
end

#rbm_text ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmText

Rich Business Messaging (RBM) text response with suggestions. Corresponds to the JSON property rbmText

Returns:



4277
4278
4279
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4277

def rbm_text
  @rbm_text
end

#simple_responses ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses

The collection of simple response candidates. This message in QueryResult.fulfillment_messages and WebhookResponse.fulfillment_messages should contain only one SimpleResponse. Corresponds to the JSON property simpleResponses

Returns:



4285
4286
4287
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4285

def simple_responses
  @simple_responses
end

#suggestions ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageSuggestions

The collection of suggestions. Corresponds to the JSON property suggestions

Returns:



4290
4291
4292
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4290

def suggestions
  @suggestions
end

#table_card ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageTableCard

Table card for Actions on Google. Corresponds to the JSON property tableCard

Returns:



4295
4296
4297
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4295

def table_card
  @table_card
end

#telephony_play_audio ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio

Plays audio from a file in Telephony Gateway. Corresponds to the JSON property telephonyPlayAudio

Returns:



4300
4301
4302
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4300

def telephony_play_audio
  @telephony_play_audio
end

#telephony_synthesize_speech ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech

Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from DetectIntentResponse.output_audio_config which can either be set at request-level or can come from the agent-level synthesizer config. Corresponds to the JSON property telephonySynthesizeSpeech

Returns:



4309
4310
4311
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4309

def telephony_synthesize_speech
  @telephony_synthesize_speech
end

#telephony_transfer_call ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall

Transfers the call in Telephony Gateway. Corresponds to the JSON property telephonyTransferCall

Returns:



4314
4315
4316
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4314

def telephony_transfer_call
  @telephony_transfer_call
end

#text ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageText

The text response message. Corresponds to the JSON property text

Returns:



4319
4320
4321
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4319

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 4326

def update!(**args)
  @basic_card = args[:basic_card] if args.key?(:basic_card)
  @browse_carousel_card = args[:browse_carousel_card] if args.key?(:browse_carousel_card)
  @card = args[:card] if args.key?(:card)
  @carousel_select = args[:carousel_select] if args.key?(:carousel_select)
  @image = args[:image] if args.key?(:image)
  @link_out_suggestion = args[:link_out_suggestion] if args.key?(:link_out_suggestion)
  @list_select = args[:list_select] if args.key?(:list_select)
  @media_content = args[:media_content] if args.key?(:media_content)
  @payload = args[:payload] if args.key?(:payload)
  @platform = args[:platform] if args.key?(:platform)
  @quick_replies = args[:quick_replies] if args.key?(:quick_replies)
  @rbm_carousel_rich_card = args[:rbm_carousel_rich_card] if args.key?(:rbm_carousel_rich_card)
  @rbm_standalone_rich_card = args[:rbm_standalone_rich_card] if args.key?(:rbm_standalone_rich_card)
  @rbm_text = args[:rbm_text] if args.key?(:rbm_text)
  @simple_responses = args[:simple_responses] if args.key?(:simple_responses)
  @suggestions = args[:suggestions] if args.key?(:suggestions)
  @table_card = args[:table_card] if args.key?(:table_card)
  @telephony_play_audio = args[:telephony_play_audio] if args.key?(:telephony_play_audio)
  @telephony_synthesize_speech = args[:telephony_synthesize_speech] if args.key?(:telephony_synthesize_speech)
  @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call)
  @text = args[:text] if args.key?(:text)
end