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



3416
3417
3418
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3416

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:



3305
3306
3307
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3305

def basic_card
  @basic_card
end

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

The card response message. Corresponds to the JSON property card

Returns:



3310
3311
3312
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3310

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:



3315
3316
3317
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3315

def carousel_select
  @carousel_select
end

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

The image response message. Corresponds to the JSON property image

Returns:



3320
3321
3322
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3320

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:



3326
3327
3328
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3326

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:



3331
3332
3333
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3331

def list_select
  @list_select
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>) 


3338
3339
3340
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3338

def payload
  @payload
end

#platform ⇒ String

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

Returns:

  • (String) 


3343
3344
3345
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3343

def platform
  @platform
end

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

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

Returns:



3348
3349
3350
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3348

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:



3360
3361
3362
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3360

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:



3372
3373
3374
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3372

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:



3377
3378
3379
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3377

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:



3385
3386
3387
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3385

def simple_responses
  @simple_responses
end

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

The collection of suggestions. Corresponds to the JSON property suggestions

Returns:



3390
3391
3392
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3390

def suggestions
  @suggestions
end

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

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

Returns:



3395
3396
3397
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3395

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:



3404
3405
3406
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3404

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:



3409
3410
3411
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3409

def telephony_transfer_call
  @telephony_transfer_call
end

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

The text response message. Corresponds to the JSON property text

Returns:



3414
3415
3416
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3414

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3421

def update!(**args)
  @basic_card = args[:basic_card] if args.key?(:basic_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)
  @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)
  @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