Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessage

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

Overview

Corresponds to the Response field in the Dialogflow console.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1IntentMessage

Returns a new instance of GoogleCloudDialogflowV2beta1IntentMessage.



11412
11413
11414
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11412

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

Instance Attribute Details

#basic_card ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCard

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

Returns:



11297
11298
11299
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11297

def basic_card
  @basic_card
end

#browse_carousel_card ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard

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

Returns:



11303
11304
11305
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11303

def browse_carousel_card
  @browse_carousel_card
end

#card ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCard

The card response message. Corresponds to the JSON property card

Returns:



11308
11309
11310
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11308

def card
  @card
end

#carousel_select ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect

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

Returns:



11313
11314
11315
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11313

def carousel_select
  @carousel_select
end

#image ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage

The image response message. Corresponds to the JSON property image

Returns:



11318
11319
11320
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11318

def image
  @image
end

#link_out_suggestion ⇒ Google::Apis::DialogflowV3beta1::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:



11324
11325
11326
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11324

def link_out_suggestion
  @link_out_suggestion
end

#list_select ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageListSelect

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

Returns:



11329
11330
11331
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11329

def list_select
  @list_select
end

#media_content ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageMediaContent

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

Returns:



11334
11335
11336
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11334

def media_content
  @media_content
end

#payload ⇒ Hash<String,Object>

A custom platform-specific response. Corresponds to the JSON property payload

Returns:

  • (Hash<String,Object>) 


11339
11340
11341
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11339

def payload
  @payload
end

#platform ⇒ String

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

Returns:

  • (String) 


11344
11345
11346
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11344

def platform
  @platform
end

#quick_replies ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageQuickReplies

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

Returns:



11349
11350
11351
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11349

def quick_replies
  @quick_replies
end

#rbm_carousel_rich_card ⇒ Google::Apis::DialogflowV3beta1::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. 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:



11357
11358
11359
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11357

def rbm_carousel_rich_card
  @rbm_carousel_rich_card
end

#rbm_standalone_rich_card ⇒ Google::Apis::DialogflowV3beta1::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. 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:



11365
11366
11367
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11365

def rbm_standalone_rich_card
  @rbm_standalone_rich_card
end

#rbm_text ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmText

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

Returns:



11370
11371
11372
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11370

def rbm_text
  @rbm_text
end

#simple_responses ⇒ Google::Apis::DialogflowV3beta1::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:



11377
11378
11379
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11377

def simple_responses
  @simple_responses
end

#suggestions ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSuggestions

The collection of suggestions. Corresponds to the JSON property suggestions

Returns:



11382
11383
11384
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11382

def suggestions
  @suggestions
end

#table_card ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTableCard

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

Returns:



11387
11388
11389
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11387

def table_card
  @table_card
end

#telephony_play_audio ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio

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

Returns:



11392
11393
11394
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11392

def telephony_play_audio
  @telephony_play_audio
end

#telephony_synthesize_speech ⇒ Google::Apis::DialogflowV3beta1::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:



11400
11401
11402
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11400

def telephony_synthesize_speech
  @telephony_synthesize_speech
end

#telephony_transfer_call ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall

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

Returns:



11405
11406
11407
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11405

def telephony_transfer_call
  @telephony_transfer_call
end

#text ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageText

The text response message. Corresponds to the JSON property text

Returns:



11410
11411
11412
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11410

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11417

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