Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v2beta1/classes.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb,
generated/google/apis/dialogflow_v2beta1/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.



3765
3766
3767
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3765

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

Instance Attribute Details

#basic_cardGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCard

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



3638
3639
3640
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3638

def basic_card
  @basic_card
end

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



3644
3645
3646
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3644

def browse_carousel_card
  @browse_carousel_card
end

#cardGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageCard

The card response message. Corresponds to the JSON property card



3649
3650
3651
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3649

def card
  @card
end

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



3654
3655
3656
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3654

def carousel_select
  @carousel_select
end

#imageGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageImage

The image response message. Corresponds to the JSON property image



3659
3660
3661
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3659

def image
  @image
end

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



3665
3666
3667
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3665

def link_out_suggestion
  @link_out_suggestion
end

#list_selectGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageListSelect

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



3670
3671
3672
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3670

def list_select
  @list_select
end

#media_contentGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageMediaContent

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



3675
3676
3677
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3675

def media_content
  @media_content
end

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


3682
3683
3684
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3682

def payload
  @payload
end

#platformString

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

Returns:

  • (String)


3687
3688
3689
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3687

def platform
  @platform
end

#quick_repliesGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageQuickReplies

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



3692
3693
3694
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3692

def quick_replies
  @quick_replies
end

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



3704
3705
3706
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3704

def rbm_carousel_rich_card
  @rbm_carousel_rich_card
end

#rbm_standalone_rich_cardGoogle::Apis::DialogflowV2beta1::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



3716
3717
3718
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3716

def rbm_standalone_rich_card
  @rbm_standalone_rich_card
end

#rbm_textGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmText

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



3721
3722
3723
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3721

def rbm_text
  @rbm_text
end

#simple_responsesGoogle::Apis::DialogflowV2beta1::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



3729
3730
3731
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3729

def simple_responses
  @simple_responses
end

#suggestionsGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageSuggestions

The collection of suggestions. Corresponds to the JSON property suggestions



3734
3735
3736
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3734

def suggestions
  @suggestions
end

#table_cardGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageTableCard

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



3739
3740
3741
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3739

def table_card
  @table_card
end

#telephony_play_audioGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio

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



3744
3745
3746
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3744

def telephony_play_audio
  @telephony_play_audio
end

#telephony_synthesize_speechGoogle::Apis::DialogflowV2beta1::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



3753
3754
3755
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3753

def telephony_synthesize_speech
  @telephony_synthesize_speech
end

#telephony_transfer_callGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall

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



3758
3759
3760
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3758

def telephony_transfer_call
  @telephony_transfer_call
end

#textGoogle::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageText

The text response message. Corresponds to the JSON property text



3763
3764
3765
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3763

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 3770

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