Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessage

Inherits:
Object
  • Object
show all
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

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.



12199
12200
12201
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12199

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

Instance Attribute Details

#basic_card ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageBasicCard

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

Returns:



12084
12085
12086
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12084

def basic_card
  @basic_card
end

#browse_carousel_card ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard

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

Returns:



12090
12091
12092
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12090

def browse_carousel_card
  @browse_carousel_card
end

#card ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageCard

The card response message. Corresponds to the JSON property card

Returns:



12095
12096
12097
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12095

def card
  @card
end

#carousel_select ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect

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

Returns:



12100
12101
12102
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12100

def carousel_select
  @carousel_select
end

#image ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageImage

The image response message. Corresponds to the JSON property image

Returns:



12105
12106
12107
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12105

def image
  @image
end

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



12111
12112
12113
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12111

def link_out_suggestion
  @link_out_suggestion
end

#list_select ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageListSelect

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

Returns:



12116
12117
12118
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12116

def list_select
  @list_select
end

#media_content ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageMediaContent

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

Returns:



12121
12122
12123
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12121

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>) 


12126
12127
12128
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12126

def payload
  @payload
end

#platform ⇒ String

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

Returns:

  • (String) 


12131
12132
12133
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12131

def platform
  @platform
end

#quick_replies ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageQuickReplies

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

Returns:



12136
12137
12138
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12136

def quick_replies
  @quick_replies
end

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



12144
12145
12146
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12144

def rbm_carousel_rich_card
  @rbm_carousel_rich_card
end

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



12152
12153
12154
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12152

def rbm_standalone_rich_card
  @rbm_standalone_rich_card
end

#rbm_text ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageRbmText

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

Returns:



12157
12158
12159
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12157

def rbm_text
  @rbm_text
end

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



12164
12165
12166
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12164

def simple_responses
  @simple_responses
end

#suggestions ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageSuggestions

The collection of suggestions. Corresponds to the JSON property suggestions

Returns:



12169
12170
12171
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12169

def suggestions
  @suggestions
end

#table_card ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageTableCard

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

Returns:



12174
12175
12176
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12174

def table_card
  @table_card
end

#telephony_play_audio ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio

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

Returns:



12179
12180
12181
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12179

def telephony_play_audio
  @telephony_play_audio
end

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



12187
12188
12189
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12187

def telephony_synthesize_speech
  @telephony_synthesize_speech
end

#telephony_transfer_call ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall

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

Returns:



12192
12193
12194
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12192

def telephony_transfer_call
  @telephony_transfer_call
end

#text ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageText

The text response message. Corresponds to the JSON property text

Returns:



12197
12198
12199
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12197

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 12204

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