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.



16986
16987
16988
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16986

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:



16871
16872
16873
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16871

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:



16877
16878
16879
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16877

def browse_carousel_card
  @browse_carousel_card
end

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

The card response message. Corresponds to the JSON property card

Returns:



16882
16883
16884
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16882

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:



16887
16888
16889
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16887

def carousel_select
  @carousel_select
end

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

The image response message. Corresponds to the JSON property image

Returns:



16892
16893
16894
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16892

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:



16898
16899
16900
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16898

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:



16903
16904
16905
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16903

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:



16908
16909
16910
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16908

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


16913
16914
16915
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16913

def payload
  @payload
end

#platform ⇒ String

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

Returns:

  • (String) 


16918
16919
16920
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16918

def platform
  @platform
end

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

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

Returns:



16923
16924
16925
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16923

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:



16931
16932
16933
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16931

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:



16939
16940
16941
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16939

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:



16944
16945
16946
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16944

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:



16951
16952
16953
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16951

def simple_responses
  @simple_responses
end

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

The collection of suggestions. Corresponds to the JSON property suggestions

Returns:



16956
16957
16958
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16956

def suggestions
  @suggestions
end

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

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

Returns:



16961
16962
16963
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16961

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:



16966
16967
16968
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16966

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:



16974
16975
16976
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16974

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:



16979
16980
16981
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16979

def telephony_transfer_call
  @telephony_transfer_call
end

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

The text response message. Corresponds to the JSON property text

Returns:



16984
16985
16986
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16984

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 16991

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