google-api-client 0.40.0 → 0.41.2

data/generated/google/apis/dialogflow_v2.rb

@@ -26,7 +26,7 @@ module Google
     # @see https://cloud.google.com/dialogflow/
     module DialogflowV2
       VERSION = 'V2'
-      REVISION = '20200526'
+      REVISION = '20200627'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

data/generated/google/apis/dialogflow_v2/classes.rb

@@ -66,17 +66,6 @@ module Google
         # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo]
         attr_accessor :form_info
       
-        # Deprecated. Please use WebhookResponse.target_page or
-        # WebhookResponse.target_flow instead.
-        # Optional for WebhookResponse.
-        # The unique identifier of the next page. This field can be set by the
-        # webhook to immediately transition to a page different from `current_page`.
-        # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
-        # ID>/flows/<Flow ID>/pages/<Page ID>`.
-        # Corresponds to the JSON property `nextPage`
-        # @return [String]
-        attr_accessor :next_page
-      
         def initialize(**args)
            update!(**args)
         end
@@ -85,7 +74,6 @@ module Google
         def update!(**args)
           @current_page = args[:current_page] if args.key?(:current_page)
           @form_info = args[:form_info] if args.key?(:form_info)
-          @next_page = args[:next_page] if args.key?(:next_page)
         end
       end
       
@@ -100,12 +88,6 @@ module Google
         # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo>]
         attr_accessor :parameter_info
       
-        # Always present for WebhookRequest. Ignored for WebhookResponse.
-        # The current state of the form.
-        # Corresponds to the JSON property `state`
-        # @return [String]
-        attr_accessor :state
-      
         def initialize(**args)
            update!(**args)
         end
@@ -113,7 +95,6 @@ module Google
         # Update properties of this object
         def update!(**args)
           @parameter_info = args[:parameter_info] if args.key?(:parameter_info)
-          @state = args[:state] if args.key?(:state)
         end
       end
       
@@ -137,14 +118,6 @@ module Google
         attr_accessor :just_collected
         alias_method :just_collected?, :just_collected
       
-        # Not set for WebhookRequest. Optional for WebhookResponse.
-        # The prompt to send to the user to fill a required form parameter. This
-        # field can be set by the webhook. If set, this field overrides the
-        # prompt defined for the form parameter.
-        # Corresponds to the JSON property `prompt`
-        # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
-        attr_accessor :prompt
-      
         # Optional for both WebhookRequest and WebhookResponse.
         # Indicates whether the parameter is required. Optional parameters will
         # not trigger prompts; however, they are filled if the user specifies
@@ -178,7 +151,6 @@ module Google
         def update!(**args)
           @display_name = args[:display_name] if args.key?(:display_name)
           @just_collected = args[:just_collected] if args.key?(:just_collected)
-          @prompt = args[:prompt] if args.key?(:prompt)
           @required = args[:required] if args.key?(:required)
           @state = args[:state] if args.key?(:state)
           @value = args[:value] if args.key?(:value)
@@ -218,6 +190,13 @@ module Google
         # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess]
         attr_accessor :conversation_success
       
+        # Indicates that interaction with the Dialogflow agent has ended.
+        # This message is generated by Dialogflow only and not supposed to be
+        # defined by the user.
+        # Corresponds to the JSON property `endInteraction`
+        # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction]
+        attr_accessor :end_interaction
+      
         # Indicates that the conversation should be handed off to a human agent.
         # Dialogflow only uses this to determine which conversations were handed off
         # to a human agent for measurement purposes. What else to do with this signal
@@ -232,11 +211,47 @@ module Google
         # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff]
         attr_accessor :human_agent_handoff
       
+        # Indicates that the conversation should be handed off to a live agent.
+        # Dialogflow only uses this to determine which conversations were handed off
+        # to a human agent for measurement purposes. What else to do with this signal
+        # is up to you and your handoff procedures.
+        # You may set this, for example:
+        # * In the entry_fulfillment of a Page if
+        # entering the page indicates something went extremely wrong in the
+        # conversation.
+        # * In a webhook response when you determine that the customer issue can only
+        # be handled by a human.
+        # Corresponds to the JSON property `liveAgentHandoff`
+        # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff]
+        attr_accessor :live_agent_handoff
+      
+        # Represents an audio message that is composed of both segments
+        # synthesized from the Dialogflow agent prompts and ones hosted externally
+        # at the specified URIs.
+        # The external URIs are specified via
+        # play_audio.
+        # This message is generated by Dialogflow only and not supposed to be
+        # defined by the user.
+        # Corresponds to the JSON property `mixedAudio`
+        # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio]
+        attr_accessor :mixed_audio
+      
+        # A text or ssml response that is preferentially used for TTS output audio
+        # synthesis, as described in the comment on the ResponseMessage message.
+        # Corresponds to the JSON property `outputAudioText`
+        # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText]
+        attr_accessor :output_audio_text
+      
         # Returns a response containing a custom, platform-specific payload.
         # Corresponds to the JSON property `payload`
         # @return [Hash<String,Object>]
         attr_accessor :payload
       
+        # Specifies an audio clip to be played by the client as part of the response.
+        # Corresponds to the JSON property `playAudio`
+        # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio]
+        attr_accessor :play_audio
+      
         # The text response message.
         # Corresponds to the JSON property `text`
         # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageText]
@@ -249,8 +264,13 @@ module Google
         # Update properties of this object
         def update!(**args)
           @conversation_success = args[:conversation_success] if args.key?(:conversation_success)
+          @end_interaction = args[:end_interaction] if args.key?(:end_interaction)
           @human_agent_handoff = args[:human_agent_handoff] if args.key?(:human_agent_handoff)
+          @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff)
+          @mixed_audio = args[:mixed_audio] if args.key?(:mixed_audio)
+          @output_audio_text = args[:output_audio_text] if args.key?(:output_audio_text)
           @payload = args[:payload] if args.key?(:payload)
+          @play_audio = args[:play_audio] if args.key?(:play_audio)
           @text = args[:text] if args.key?(:text)
         end
       end
@@ -285,6 +305,21 @@ module Google
         end
       end
       
+      # Indicates that interaction with the Dialogflow agent has ended.
+      # This message is generated by Dialogflow only and not supposed to be
+      # defined by the user.
+      class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Indicates that the conversation should be handed off to a human agent.
       # Dialogflow only uses this to determine which conversations were handed off
       # to a human agent for measurement purposes. What else to do with this signal
@@ -314,11 +349,167 @@ module Google
         end
       end
       
+      # Indicates that the conversation should be handed off to a live agent.
+      # Dialogflow only uses this to determine which conversations were handed off
+      # to a human agent for measurement purposes. What else to do with this signal
+      # is up to you and your handoff procedures.
+      # You may set this, for example:
+      # * In the entry_fulfillment of a Page if
+      # entering the page indicates something went extremely wrong in the
+      # conversation.
+      # * In a webhook response when you determine that the customer issue can only
+      # be handled by a human.
+      class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff
+        include Google::Apis::Core::Hashable
+      
+        # Custom metadata for your handoff procedure. Dialogflow doesn't impose
+        # any structure on this.
+        # Corresponds to the JSON property `metadata`
+        # @return [Hash<String,Object>]
+        attr_accessor :metadata
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @metadata = args[:metadata] if args.key?(:metadata)
+        end
+      end
+      
+      # Represents an audio message that is composed of both segments
+      # synthesized from the Dialogflow agent prompts and ones hosted externally
+      # at the specified URIs.
+      # The external URIs are specified via
+      # play_audio.
+      # This message is generated by Dialogflow only and not supposed to be
+      # defined by the user.
+      class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio
+        include Google::Apis::Core::Hashable
+      
+        # Segments this audio response is composed of.
+        # Corresponds to the JSON property `segments`
+        # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment>]
+        attr_accessor :segments
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @segments = args[:segments] if args.key?(:segments)
+        end
+      end
+      
+      # Represents one segment of audio.
+      class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment
+        include Google::Apis::Core::Hashable
+      
+        # Whether the playback of this segment can be interrupted by the end
+        # user's speech and the client should then start the next Dialogflow
+        # request.
+        # Corresponds to the JSON property `allowPlaybackInterruption`
+        # @return [Boolean]
+        attr_accessor :allow_playback_interruption
+        alias_method :allow_playback_interruption?, :allow_playback_interruption
+      
+        # Raw audio synthesized from the Dialogflow agent's response using
+        # the output config specified in the request.
+        # Corresponds to the JSON property `audio`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :audio
+      
+        # Client-specific URI that points to an audio clip accessible to the
+        # client. Dialogflow does not impose any validation on it.
+        # Corresponds to the JSON property `uri`
+        # @return [String]
+        attr_accessor :uri
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
+          @audio = args[:audio] if args.key?(:audio)
+          @uri = args[:uri] if args.key?(:uri)
+        end
+      end
+      
+      # A text or ssml response that is preferentially used for TTS output audio
+      # synthesis, as described in the comment on the ResponseMessage message.
+      class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText
+        include Google::Apis::Core::Hashable
+      
+        # The SSML text to be synthesized. For more information, see
+        # [SSML](/speech/text-to-speech/docs/ssml).
+        # Corresponds to the JSON property `ssml`
+        # @return [String]
+        attr_accessor :ssml
+      
+        # The raw text to be synthesized.
+        # Corresponds to the JSON property `text`
+        # @return [String]
+        attr_accessor :text
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @ssml = args[:ssml] if args.key?(:ssml)
+          @text = args[:text] if args.key?(:text)
+        end
+      end
+      
+      # Specifies an audio clip to be played by the client as part of the response.
+      class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio
+        include Google::Apis::Core::Hashable
+      
+        # Whether the playback of this message can be interrupted by the end
+        # user's speech and the client can then starts the next Dialogflow
+        # request.
+        # Corresponds to the JSON property `allowPlaybackInterruption`
+        # @return [Boolean]
+        attr_accessor :allow_playback_interruption
+        alias_method :allow_playback_interruption?, :allow_playback_interruption
+      
+        # Required. URI of the audio clip. Dialogflow does not impose any validation on
+        # this
+        # value. It is specific to the client that reads it.
+        # Corresponds to the JSON property `audioUri`
+        # @return [String]
+        attr_accessor :audio_uri
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
+          @audio_uri = args[:audio_uri] if args.key?(:audio_uri)
+        end
+      end
+      
       # The text response message.
       class GoogleCloudDialogflowCxV3beta1ResponseMessageText
         include Google::Apis::Core::Hashable
       
-        # A collection of text responses.
+        # Whether the playback of this message can be interrupted by the end
+        # user's speech and the client can then starts the next Dialogflow
+        # request.
+        # Corresponds to the JSON property `allowPlaybackInterruption`
+        # @return [Boolean]
+        attr_accessor :allow_playback_interruption
+        alias_method :allow_playback_interruption?, :allow_playback_interruption
+      
+        # Required. A collection of text responses.
         # Corresponds to the JSON property `text`
         # @return [Array<String>]
         attr_accessor :text
@@ -329,6 +520,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption)
           @text = args[:text] if args.key?(:text)
         end
       end
@@ -579,7 +771,15 @@ module Google
         end
       end
       
-      # Represents a conversational agent.
+      # A Dialogflow agent is a virtual agent that handles conversations with your
+      # end-users. It is a natural language understanding module that understands the
+      # nuances of human language. Dialogflow translates end-user text or audio
+      # during a conversation to structured data that your apps and services can
+      # understand. You design and build a Dialogflow agent to handle the types of
+      # conversations required for your system.
+      # For more information about agents, see the
+      # [Agents
+      # documentation](https://cloud.google.com/dialogflow/docs/agents-overview).
       class GoogleCloudDialogflowV2Agent
         include Google::Apis::Core::Hashable
       
@@ -3536,8 +3736,16 @@ module Google
         # @return [String]
         attr_accessor :query_text
       
-        # The result of sentiment analysis as configured by
-        # `sentiment_analysis_request_config`.
+        # The result of sentiment analysis. Sentiment analysis inspects user input
+        # and identifies the prevailing subjective opinion, especially to determine a
+        # user's attitude as positive, negative, or neutral.
+        # For Participants.AnalyzeContent, it needs to be configured in
+        # DetectIntentRequest.query_params. For
+        # Participants.StreamingAnalyzeContent, it needs to be configured in
+        # StreamingDetectIntentRequest.query_params.
+        # And for Participants.AnalyzeContent and
+        # Participants.StreamingAnalyzeContent, it needs to be configured in
+        # ConversationProfile.human_agent_assistant_config
         # Corresponds to the JSON property `sentimentAnalysisResult`
         # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisResult]
         attr_accessor :sentiment_analysis_result
@@ -3694,8 +3902,16 @@ module Google
         end
       end
       
-      # The result of sentiment analysis as configured by
-      # `sentiment_analysis_request_config`.
+      # The result of sentiment analysis. Sentiment analysis inspects user input
+      # and identifies the prevailing subjective opinion, especially to determine a
+      # user's attitude as positive, negative, or neutral.
+      # For Participants.AnalyzeContent, it needs to be configured in
+      # DetectIntentRequest.query_params. For
+      # Participants.StreamingAnalyzeContent, it needs to be configured in
+      # StreamingDetectIntentRequest.query_params.
+      # And for Participants.AnalyzeContent and
+      # Participants.StreamingAnalyzeContent, it needs to be configured in
+      # ConversationProfile.human_agent_assistant_config
       class GoogleCloudDialogflowV2SentimentAnalysisResult
         include Google::Apis::Core::Hashable
       
@@ -4741,9 +4957,6 @@ module Google
         # 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/business-communications/rcs-business-messaging/
-        # guides/build/messages/send#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`
@@ -4753,9 +4966,6 @@ module Google
         # 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/business-communications/rcs-business-messaging/
-        # guides/build/messages/send#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`
@@ -5463,7 +5673,7 @@ module Google
         attr_accessor :file_uri
       
         # Required for cards with vertical orientation. The height of the media
-        # within a rich card with a vertical layout. (https://goo.gl/NeFCjz).
+        # within a rich card with a vertical layout.
         # For a standalone card with horizontal layout, height is not
         # customizable, and this field is ignored.
         # Corresponds to the JSON property `height`
@@ -5494,9 +5704,6 @@ module Google
       # 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/business-communications/rcs-business-messaging/
-      # guides/build/messages/send#rich-cards
       # If you want to show a single card with more control over the layout,
       # please use RbmStandaloneCard instead.
       class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard
@@ -5527,9 +5734,6 @@ module Google
       # 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/business-communications/rcs-business-messaging/
-      # guides/build/messages/send#rich-cards
       # You can group multiple rich cards into one using RbmCarouselCard but
       # carousel cards will give you less control over the card layout.
       class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard
@@ -5569,13 +5773,13 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Opens the user's default dialer app with the specified phone number
-        # but does not dial automatically (https://goo.gl/ergbB2).
+        # but does not dial automatically.
         # Corresponds to the JSON property `dial`
         # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial]
         attr_accessor :dial
       
         # Opens the user's default web browser app to the specified uri
-        # (https://goo.gl/6GLJD2). If the user has an app installed that is
+        # If the user has an app installed that is
         # registered as the default handler for the URL, then this app will be
         # opened instead, and its icon will be used in the suggested action UI.
         # Corresponds to the JSON property `openUrl`
@@ -5590,7 +5794,7 @@ module Google
         attr_accessor :postback_data
       
         # Opens the device's location chooser so the user can pick a location
-        # to send back to the agent (https://goo.gl/GXotJW).
+        # to send back to the agent.
         # Corresponds to the JSON property `shareLocation`
         # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation]
         attr_accessor :share_location
@@ -5615,7 +5819,7 @@ module Google
       end
       
       # Opens the user's default dialer app with the specified phone number
-      # but does not dial automatically (https://goo.gl/ergbB2).
+      # but does not dial automatically.
       class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial
         include Google::Apis::Core::Hashable
       
@@ -5638,7 +5842,7 @@ module Google
       end
       
       # Opens the user's default web browser app to the specified uri
-      # (https://goo.gl/6GLJD2). If the user has an app installed that is
+      # If the user has an app installed that is
       # registered as the default handler for the URL, then this app will be
       # opened instead, and its icon will be used in the suggested action UI.
       class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri
@@ -5660,7 +5864,7 @@ module Google
       end
       
       # Opens the device's location chooser so the user can pick a location
-      # to send back to the agent (https://goo.gl/GXotJW).
+      # to send back to the agent.
       class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation
         include Google::Apis::Core::Hashable
       
@@ -6519,8 +6723,16 @@ module Google
         # @return [String]
         attr_accessor :query_text
       
-        # The result of sentiment analysis as configured by
-        # `sentiment_analysis_request_config`.
+        # The result of sentiment analysis. Sentiment analysis inspects user input
+        # and identifies the prevailing subjective opinion, especially to determine a
+        # user's attitude as positive, negative, or neutral.
+        # For Participants.AnalyzeContent, it needs to be configured in
+        # DetectIntentRequest.query_params. For
+        # Participants.StreamingAnalyzeContent, it needs to be configured in
+        # StreamingDetectIntentRequest.query_params.
+        # And for Participants.AnalyzeContent and
+        # Participants.StreamingAnalyzeContent, it needs to be configured in
+        # ConversationProfile.human_agent_assistant_config
         # Corresponds to the JSON property `sentimentAnalysisResult`
         # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SentimentAnalysisResult]
         attr_accessor :sentiment_analysis_result
@@ -6602,8 +6814,16 @@ module Google
         end
       end
       
-      # The result of sentiment analysis as configured by
-      # `sentiment_analysis_request_config`.
+      # The result of sentiment analysis. Sentiment analysis inspects user input
+      # and identifies the prevailing subjective opinion, especially to determine a
+      # user's attitude as positive, negative, or neutral.
+      # For Participants.AnalyzeContent, it needs to be configured in
+      # DetectIntentRequest.query_params. For
+      # Participants.StreamingAnalyzeContent, it needs to be configured in
+      # StreamingDetectIntentRequest.query_params.
+      # And for Participants.AnalyzeContent and
+      # Participants.StreamingAnalyzeContent, it needs to be configured in
+      # ConversationProfile.human_agent_assistant_config
       class GoogleCloudDialogflowV2beta1SentimentAnalysisResult
         include Google::Apis::Core::Hashable