# Copyright 2015 Google Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'date' require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module DialogflowV2 # The response message for Agents.ExportAgent. class GoogleCloudDialogflowCxV3beta1ExportAgentResponse include Google::Apis::Core::Hashable # Uncompressed raw byte content for agent. # Corresponds to the JSON property `agentContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :agent_content # The URI to a file containing the exported agent. This field is populated # only if `agent_uri` is specified in ExportAgentRequest. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @agent_content = args[:agent_content] if args.key?(:agent_content) @agent_uri = args[:agent_uri] if args.key?(:agent_uri) end end # Represents page information communicated to and from the webhook. class GoogleCloudDialogflowCxV3beta1PageInfo include Google::Apis::Core::Hashable # Always present for WebhookRequest. Ignored for WebhookResponse. # The unique identifier of the current page. # Format: `projects//locations//agents//flows//pages/`. # Corresponds to the JSON property `currentPage` # @return [String] attr_accessor :current_page # Represents form information. # Corresponds to the JSON property `formInfo` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo] attr_accessor :form_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @current_page = args[:current_page] if args.key?(:current_page) @form_info = args[:form_info] if args.key?(:form_info) end end # Represents form information. class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo include Google::Apis::Core::Hashable # Optional for both WebhookRequest and WebhookResponse. # The parameters contained in the form. Note that the webhook cannot add # or remove any form parameter. # Corresponds to the JSON property `parameterInfo` # @return [Array] attr_accessor :parameter_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @parameter_info = args[:parameter_info] if args.key?(:parameter_info) end end # Represents parameter information. class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo include Google::Apis::Core::Hashable # Always present for WebhookRequest. Required for # WebhookResponse. # The human-readable name of the parameter, unique within the form. This # field cannot be modified by the webhook. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional for WebhookRequest. Ignored for WebhookResponse. # Indicates if the parameter value was just collected on the last # conversation turn. # Corresponds to the JSON property `justCollected` # @return [Boolean] attr_accessor :just_collected alias_method :just_collected?, :just_collected # 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 # them. Required parameters must be filled before form filling concludes. # Corresponds to the JSON property `required` # @return [Boolean] attr_accessor :required alias_method :required?, :required # Always present for WebhookRequest. Required for # WebhookResponse. The state of the parameter. This field can be set # to INVALID by # the webhook to invalidate the parameter; other values set by the # webhook will be ignored. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Optional for both WebhookRequest and WebhookResponse. # The value of the parameter. This field can be set by the webhook to # change the parameter value. # Corresponds to the JSON property `value` # @return [Object] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @just_collected = args[:just_collected] if args.key?(:just_collected) @required = args[:required] if args.key?(:required) @state = args[:state] if args.key?(:state) @value = args[:value] if args.key?(:value) end end # Represents a response message that can be returned by a conversational agent. # Response messages are also used for output audio synthesis. The approach is # as follows: # * If at least one OutputAudioText response is present, then all # OutputAudioText responses are linearly concatenated, and the result is used # for output audio synthesis. # * If the OutputAudioText responses are a mixture of text and SSML, then the # concatenated result is treated as SSML; otherwise, the result is treated as # either text or SSML as appropriate. The agent designer should ideally use # either text or SSML consistently throughout the bot design. # * Otherwise, all Text responses are linearly concatenated, and the result is # used for output audio synthesis. # This approach allows for more sophisticated user experience scenarios, where # the text displayed to the user may differ from what is heard. class GoogleCloudDialogflowCxV3beta1ResponseMessage include Google::Apis::Core::Hashable # Indicates that the conversation succeeded, i.e., the bot handled the issue # that the customer talked to it about. # Dialogflow only uses this to determine which conversations should be # counted as successful and doesn't process the metadata in this message in # any way. Note that Dialogflow also considers conversations that get to the # conversation end page as successful even if they don't return # ConversationSuccess. # You may set this, for example: # * In the entry_fulfillment of a Page if # entering the page indicates that the conversation succeeded. # * In a webhook response when you determine that you handled the customer # issue. # Corresponds to the JSON property `conversationSuccess` # @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 # 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 `humanAgentHandoff` # @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] 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] attr_accessor :text def initialize(**args) update!(**args) end # 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 # Indicates that the conversation succeeded, i.e., the bot handled the issue # that the customer talked to it about. # Dialogflow only uses this to determine which conversations should be # counted as successful and doesn't process the metadata in this message in # any way. Note that Dialogflow also considers conversations that get to the # conversation end page as successful even if they don't return # ConversationSuccess. # You may set this, for example: # * In the entry_fulfillment of a Page if # entering the page indicates that the conversation succeeded. # * In a webhook response when you determine that you handled the customer # issue. class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess include Google::Apis::Core::Hashable # Custom metadata. Dialogflow doesn't impose any structure on this. # Corresponds to the JSON property `metadata` # @return [Hash] 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 # 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 # 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 GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff 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] 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 # 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] 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] 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 # 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] attr_accessor :text 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) @text = args[:text] if args.key?(:text) end end # Represents session information communicated to and from the webhook. class GoogleCloudDialogflowCxV3beta1SessionInfo include Google::Apis::Core::Hashable # Optional for WebhookRequest. Optional for WebhookResponse. # All parameters collected from forms and intents during the session. # Parameters can be created, updated, or removed by the webhook. To remove a # parameter from the session, the webhook should explicitly set the parameter # value to null in WebhookResponse. The map is keyed by parameters' # display names. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters # Always present for WebhookRequest. Ignored for WebhookResponse. # The unique identifier of the session. This # field can be used by the webhook to identify a user. # Format: `projects//locations//agents//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @parameters = args[:parameters] if args.key?(:parameters) @session = args[:session] if args.key?(:session) end end # The request message for a webhook call. class GoogleCloudDialogflowCxV3beta1WebhookRequest include Google::Apis::Core::Hashable # Always present. The unique identifier of the DetectIntentResponse that # will be returned to the API caller. # Corresponds to the JSON property `detectIntentResponseId` # @return [String] attr_accessor :detect_intent_response_id # Represents fulfillment information communicated to the webhook. # Corresponds to the JSON property `fulfillmentInfo` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo] attr_accessor :fulfillment_info # Represents intent information communicated to the webhook. # Corresponds to the JSON property `intentInfo` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo] attr_accessor :intent_info # The list of rich message responses to present to the user. Webhook can # choose to append or replace this list in # WebhookResponse.fulfillment_response; # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages # Represents page information communicated to and from the webhook. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfo] attr_accessor :page_info # Custom data set in QueryParameters.payload. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Represents session information communicated to and from the webhook. # Corresponds to the JSON property `sessionInfo` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo] attr_accessor :session_info def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @detect_intent_response_id = args[:detect_intent_response_id] if args.key?(:detect_intent_response_id) @fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info) @intent_info = args[:intent_info] if args.key?(:intent_info) @messages = args[:messages] if args.key?(:messages) @page_info = args[:page_info] if args.key?(:page_info) @payload = args[:payload] if args.key?(:payload) @session_info = args[:session_info] if args.key?(:session_info) end end # Represents fulfillment information communicated to the webhook. class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo include Google::Apis::Core::Hashable # Always present. The tag used to identify which fulfillment is being # called. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @tag = args[:tag] if args.key?(:tag) end end # Represents intent information communicated to the webhook. class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo include Google::Apis::Core::Hashable # Always present. The unique identifier of the last matched # intent. Format: `projects//locations//agents//intents/`. # Corresponds to the JSON property `lastMatchedIntent` # @return [String] attr_accessor :last_matched_intent # Parameters identified as a result of intent matching. This is a map of # the name of the identified parameter to the value of the parameter # identified from the user's utterance. All parameters defined in the # matched intent that are identified will be surfaced here. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @last_matched_intent = args[:last_matched_intent] if args.key?(:last_matched_intent) @parameters = args[:parameters] if args.key?(:parameters) end end # Represents a value for an intent parameter. class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue include Google::Apis::Core::Hashable # Always present. Original text value extracted from user utterance. # Corresponds to the JSON property `originalValue` # @return [String] attr_accessor :original_value # Always present. Structured value for the parameter extracted from user # utterance. # Corresponds to the JSON property `resolvedValue` # @return [Object] attr_accessor :resolved_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @original_value = args[:original_value] if args.key?(:original_value) @resolved_value = args[:resolved_value] if args.key?(:resolved_value) end end # The response message for a webhook call. class GoogleCloudDialogflowCxV3beta1WebhookResponse include Google::Apis::Core::Hashable # Represents a fulfillment response to the user. # Corresponds to the JSON property `fulfillmentResponse` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse] attr_accessor :fulfillment_response # Represents page information communicated to and from the webhook. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1PageInfo] attr_accessor :page_info # Value to append directly to QueryResult.webhook_payloads. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Represents session information communicated to and from the webhook. # Corresponds to the JSON property `sessionInfo` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo] attr_accessor :session_info # The target flow to transition to. # Format: `projects//locations//agents//flows/`. # Corresponds to the JSON property `targetFlow` # @return [String] attr_accessor :target_flow # The target page to transition to. # Format: `projects//locations//agents//flows//pages/`. # Corresponds to the JSON property `targetPage` # @return [String] attr_accessor :target_page def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fulfillment_response = args[:fulfillment_response] if args.key?(:fulfillment_response) @page_info = args[:page_info] if args.key?(:page_info) @payload = args[:payload] if args.key?(:payload) @session_info = args[:session_info] if args.key?(:session_info) @target_flow = args[:target_flow] if args.key?(:target_flow) @target_page = args[:target_page] if args.key?(:target_page) end end # Represents a fulfillment response to the user. class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse include Google::Apis::Core::Hashable # Merge behavior for `messages`. # Corresponds to the JSON property `mergeBehavior` # @return [String] attr_accessor :merge_behavior # The list of rich message responses to present to the user. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @merge_behavior = args[:merge_behavior] if args.key?(:merge_behavior) @messages = args[:messages] if args.key?(:messages) end end # 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 # Optional. API version displayed in Dialogflow console. If not specified, # V2 API is assumed. Clients are free to query different service endpoints # for different API versions. However, bots connectors and webhook calls will # follow the specified API version. # Corresponds to the JSON property `apiVersion` # @return [String] attr_accessor :api_version # Optional. The URI of the agent's avatar. # Avatars are used throughout the Dialogflow console and in the self-hosted # [Web # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) # integration. # Corresponds to the JSON property `avatarUri` # @return [String] attr_accessor :avatar_uri # Optional. To filter out false positive results and still get variety in # matched natural language inputs for your agent, you can tune the machine # learning classification threshold. If the returned score value is less than # the threshold value, then a fallback intent will be triggered or, if there # are no fallback intents defined, no intent will be triggered. The score # values range from 0.0 (completely uncertain) to 1.0 (completely certain). # If set to 0.0, the default of 0.3 is used. # Corresponds to the JSON property `classificationThreshold` # @return [Float] attr_accessor :classification_threshold # Required. The default language of the agent as a language tag. See # [Language # Support](https://cloud.google.com/dialogflow/docs/reference/language) # for a list of the currently supported language codes. This field cannot be # set by the `Update` method. # Corresponds to the JSON property `defaultLanguageCode` # @return [String] attr_accessor :default_language_code # Optional. The description of this agent. # The maximum length is 500 characters. If exceeded, the request is rejected. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Required. The name of this agent. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional. Determines whether this agent should log conversation queries. # Corresponds to the JSON property `enableLogging` # @return [Boolean] attr_accessor :enable_logging alias_method :enable_logging?, :enable_logging # Optional. Determines how intents are detected from user queries. # Corresponds to the JSON property `matchMode` # @return [String] attr_accessor :match_mode # Required. The project of this agent. # Format: `projects/`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent # Optional. The list of all languages supported by this agent (except for the # `default_language_code`). # Corresponds to the JSON property `supportedLanguageCodes` # @return [Array] attr_accessor :supported_language_codes # Optional. The agent tier. If not specified, TIER_STANDARD is assumed. # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier # Required. The time zone of this agent from the # [time zone database](https://www.iana.org/time-zones), e.g., # America/New_York, Europe/Paris. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @api_version = args[:api_version] if args.key?(:api_version) @avatar_uri = args[:avatar_uri] if args.key?(:avatar_uri) @classification_threshold = args[:classification_threshold] if args.key?(:classification_threshold) @default_language_code = args[:default_language_code] if args.key?(:default_language_code) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @enable_logging = args[:enable_logging] if args.key?(:enable_logging) @match_mode = args[:match_mode] if args.key?(:match_mode) @parent = args[:parent] if args.key?(:parent) @supported_language_codes = args[:supported_language_codes] if args.key?(:supported_language_codes) @tier = args[:tier] if args.key?(:tier) @time_zone = args[:time_zone] if args.key?(:time_zone) end end # Represents a part of a message possibly annotated with an entity. The part # can be an entity or purely a part of the message between two entities or # message start/end. class GoogleCloudDialogflowV2AnnotatedMessagePart include Google::Apis::Core::Hashable # The [Dialogflow system entity # type](https://cloud.google.com/dialogflow/docs/reference/system-entities) # of this message part. If this is empty, Dialogflow could not annotate the # phrase part with a system entity. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type # The [Dialogflow system entity formatted value # ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of # this message part. For example for a system entity of type # `@sys.unit-currency`, this may contain: #
        # `
        # "amount": 5,
        # "currency": "USD"
        # `
        # 
# Corresponds to the JSON property `formattedValue` # @return [Object] attr_accessor :formatted_value # A part of a message possibly annotated with an entity. # 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) @entity_type = args[:entity_type] if args.key?(:entity_type) @formatted_value = args[:formatted_value] if args.key?(:formatted_value) @text = args[:text] if args.key?(:text) end end # The request message for EntityTypes.BatchCreateEntities. class GoogleCloudDialogflowV2BatchCreateEntitiesRequest include Google::Apis::Core::Hashable # Required. The entities to create. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entities = args[:entities] if args.key?(:entities) @language_code = args[:language_code] if args.key?(:language_code) end end # The request message for EntityTypes.BatchDeleteEntities. class GoogleCloudDialogflowV2BatchDeleteEntitiesRequest include Google::Apis::Core::Hashable # Required. The reference `values` of the entities to delete. Note that # these are not fully-qualified names, i.e. they don't start with # `projects/`. # Corresponds to the JSON property `entityValues` # @return [Array] attr_accessor :entity_values # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_values = args[:entity_values] if args.key?(:entity_values) @language_code = args[:language_code] if args.key?(:language_code) end end # The request message for EntityTypes.BatchDeleteEntityTypes. class GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest include Google::Apis::Core::Hashable # Required. The names entity types to delete. All names must point to the # same agent as `parent`. # Corresponds to the JSON property `entityTypeNames` # @return [Array] attr_accessor :entity_type_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_type_names = args[:entity_type_names] if args.key?(:entity_type_names) end end # The request message for Intents.BatchDeleteIntents. class GoogleCloudDialogflowV2BatchDeleteIntentsRequest include Google::Apis::Core::Hashable # Required. The collection of intents to delete. Only intent `name` must be # filled in. # Corresponds to the JSON property `intents` # @return [Array] attr_accessor :intents def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @intents = args[:intents] if args.key?(:intents) end end # The request message for EntityTypes.BatchUpdateEntities. class GoogleCloudDialogflowV2BatchUpdateEntitiesRequest include Google::Apis::Core::Hashable # Required. The entities to update or create. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Optional. The mask to control which fields get updated. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entities = args[:entities] if args.key?(:entities) @language_code = args[:language_code] if args.key?(:language_code) @update_mask = args[:update_mask] if args.key?(:update_mask) end end # The request message for EntityTypes.BatchUpdateEntityTypes. class GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest include Google::Apis::Core::Hashable # This message is a wrapper around a collection of entity types. # Corresponds to the JSON property `entityTypeBatchInline` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityTypeBatch] attr_accessor :entity_type_batch_inline # The URI to a Google Cloud Storage file containing entity types to update # or create. The file format can either be a serialized proto (of # EntityBatch type) or a JSON object. Note: The URI must start with # "gs://". # Corresponds to the JSON property `entityTypeBatchUri` # @return [String] attr_accessor :entity_type_batch_uri # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Optional. The mask to control which fields get updated. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_type_batch_inline = args[:entity_type_batch_inline] if args.key?(:entity_type_batch_inline) @entity_type_batch_uri = args[:entity_type_batch_uri] if args.key?(:entity_type_batch_uri) @language_code = args[:language_code] if args.key?(:language_code) @update_mask = args[:update_mask] if args.key?(:update_mask) end end # The response message for EntityTypes.BatchUpdateEntityTypes. class GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse include Google::Apis::Core::Hashable # The collection of updated or created entity types. # Corresponds to the JSON property `entityTypes` # @return [Array] attr_accessor :entity_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_types = args[:entity_types] if args.key?(:entity_types) end end # class GoogleCloudDialogflowV2BatchUpdateIntentsRequest include Google::Apis::Core::Hashable # This message is a wrapper around a collection of intents. # Corresponds to the JSON property `intentBatchInline` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentBatch] attr_accessor :intent_batch_inline # The URI to a Google Cloud Storage file containing intents to update or # create. The file format can either be a serialized proto (of IntentBatch # type) or JSON object. Note: The URI must start with "gs://". # Corresponds to the JSON property `intentBatchUri` # @return [String] attr_accessor :intent_batch_uri # Optional. The resource view to apply to the returned intent. # Corresponds to the JSON property `intentView` # @return [String] attr_accessor :intent_view # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Optional. The mask to control which fields get updated. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @intent_batch_inline = args[:intent_batch_inline] if args.key?(:intent_batch_inline) @intent_batch_uri = args[:intent_batch_uri] if args.key?(:intent_batch_uri) @intent_view = args[:intent_view] if args.key?(:intent_view) @language_code = args[:language_code] if args.key?(:language_code) @update_mask = args[:update_mask] if args.key?(:update_mask) end end # The response message for Intents.BatchUpdateIntents. class GoogleCloudDialogflowV2BatchUpdateIntentsResponse include Google::Apis::Core::Hashable # The collection of updated or created intents. # Corresponds to the JSON property `intents` # @return [Array] attr_accessor :intents def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @intents = args[:intents] if args.key?(:intents) end end # Represents a context. class GoogleCloudDialogflowV2Context include Google::Apis::Core::Hashable # Optional. The number of conversational query requests after which the # context expires. The default is `0`. If set to `0`, the context expires # immediately. Contexts expire automatically after 20 minutes if there # are no matching queries. # Corresponds to the JSON property `lifespanCount` # @return [Fixnum] attr_accessor :lifespan_count # Required. The unique identifier of the context. Format: # `projects//agent/sessions//contexts/`, # or `projects//agent/environments//users//sessions//contexts/`. # The `Context ID` is always converted to lowercase, may only contain # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. # If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # The following context names are reserved for internal use by Dialogflow. # You should not use these contexts or create contexts with these names: # * `__system_counters__` # * `*_id_dialog_context` # * `*_dialog_params_size` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The collection of parameters associated with this context. # Depending on your protocol or client library language, this is a # map, associative array, symbol table, dictionary, or JSON object # composed of a collection of (MapKey, MapValue) pairs: # - MapKey type: string # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @lifespan_count = args[:lifespan_count] if args.key?(:lifespan_count) @name = args[:name] if args.key?(:name) @parameters = args[:parameters] if args.key?(:parameters) end end # Represents a notification sent to Cloud Pub/Sub subscribers for conversation # lifecycle events. class GoogleCloudDialogflowV2ConversationEvent include Google::Apis::Core::Hashable # The unique identifier of the conversation this notification # refers to. # Format: `projects//conversations/`. # Corresponds to the JSON property `conversation` # @return [String] attr_accessor :conversation # The `Status` type defines a logical error model that is suitable for # different programming environments, including REST APIs and RPC APIs. It is # used by [gRPC](https://github.com/grpc). Each `Status` message contains # three pieces of data: error code, error message, and error details. # You can find out more about this error model and how to work with it in the # [API Design Guide](https://cloud.google.com/apis/design/errors). # Corresponds to the JSON property `errorStatus` # @return [Google::Apis::DialogflowV2::GoogleRpcStatus] attr_accessor :error_status # Represents a message posted into a conversation. # Corresponds to the JSON property `newMessagePayload` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Message] attr_accessor :new_message_payload # The type of the event that this notification refers to. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conversation = args[:conversation] if args.key?(:conversation) @error_status = args[:error_status] if args.key?(:error_status) @new_message_payload = args[:new_message_payload] if args.key?(:new_message_payload) @type = args[:type] if args.key?(:type) end end # The request to detect user's intent. class GoogleCloudDialogflowV2DetectIntentRequest include Google::Apis::Core::Hashable # The natural language speech audio to be processed. This field # should be populated iff `query_input` is set to an input audio config. # A single request can contain up to 1 minute of speech audio data. # Corresponds to the JSON property `inputAudio` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :input_audio # Instructs the speech synthesizer on how to generate the output audio content. # If this audio config is supplied in a request, it overrides all existing # text-to-speech settings applied to the agent. # Corresponds to the JSON property `outputAudioConfig` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig] attr_accessor :output_audio_config # Mask for output_audio_config indicating which settings in this # request-level config should override speech synthesizer settings defined at # agent-level. # If unspecified or empty, output_audio_config replaces the agent-level # config in its entirety. # Corresponds to the JSON property `outputAudioConfigMask` # @return [String] attr_accessor :output_audio_config_mask # Represents the query input. It can contain either: # 1. An audio config which # instructs the speech recognizer how to process the speech audio. # 2. A conversational query in the form of text,. # 3. An event that specifies which intent to trigger. # Corresponds to the JSON property `queryInput` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryInput] attr_accessor :query_input # Represents the parameters of the conversational query. # Corresponds to the JSON property `queryParams` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryParameters] attr_accessor :query_params def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @input_audio = args[:input_audio] if args.key?(:input_audio) @output_audio_config = args[:output_audio_config] if args.key?(:output_audio_config) @output_audio_config_mask = args[:output_audio_config_mask] if args.key?(:output_audio_config_mask) @query_input = args[:query_input] if args.key?(:query_input) @query_params = args[:query_params] if args.key?(:query_params) end end # The message returned from the DetectIntent method. class GoogleCloudDialogflowV2DetectIntentResponse include Google::Apis::Core::Hashable # The audio data bytes encoded as specified in the request. # Note: The output audio is generated based on the values of default platform # text responses found in the `query_result.fulfillment_messages` field. If # multiple default text responses exist, they will be concatenated when # generating audio. If no default platform text responses exist, the # generated audio content will be empty. # In some scenarios, multiple output audio fields may be present in the # response structure. In these cases, only the top-most-level audio output # has content. # Corresponds to the JSON property `outputAudio` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :output_audio # Instructs the speech synthesizer on how to generate the output audio content. # If this audio config is supplied in a request, it overrides all existing # text-to-speech settings applied to the agent. # Corresponds to the JSON property `outputAudioConfig` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig] attr_accessor :output_audio_config # Represents the result of conversational query or event processing. # Corresponds to the JSON property `queryResult` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryResult] attr_accessor :query_result # The unique identifier of the response. It can be used to # locate a response in the training example set or for reporting issues. # Corresponds to the JSON property `responseId` # @return [String] attr_accessor :response_id # The `Status` type defines a logical error model that is suitable for # different programming environments, including REST APIs and RPC APIs. It is # used by [gRPC](https://github.com/grpc). Each `Status` message contains # three pieces of data: error code, error message, and error details. # You can find out more about this error model and how to work with it in the # [API Design Guide](https://cloud.google.com/apis/design/errors). # Corresponds to the JSON property `webhookStatus` # @return [Google::Apis::DialogflowV2::GoogleRpcStatus] attr_accessor :webhook_status def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @output_audio = args[:output_audio] if args.key?(:output_audio) @output_audio_config = args[:output_audio_config] if args.key?(:output_audio_config) @query_result = args[:query_result] if args.key?(:query_result) @response_id = args[:response_id] if args.key?(:response_id) @webhook_status = args[:webhook_status] if args.key?(:webhook_status) end end # Represents an entity type. # Entity types serve as a tool for extracting parameter values from natural # language queries. class GoogleCloudDialogflowV2EntityType include Google::Apis::Core::Hashable # Optional. Indicates whether the entity type can be automatically # expanded. # Corresponds to the JSON property `autoExpansionMode` # @return [String] attr_accessor :auto_expansion_mode # Required. The name of the entity type. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional. Enables fuzzy entity extraction during classification. # Corresponds to the JSON property `enableFuzzyExtraction` # @return [Boolean] attr_accessor :enable_fuzzy_extraction alias_method :enable_fuzzy_extraction?, :enable_fuzzy_extraction # Optional. The collection of entity entries associated with the entity type. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # Required. Indicates the kind of entity type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The unique identifier of the entity type. # Required for EntityTypes.UpdateEntityType and # EntityTypes.BatchUpdateEntityTypes methods. # Format: `projects//agent/entityTypes/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_expansion_mode = args[:auto_expansion_mode] if args.key?(:auto_expansion_mode) @display_name = args[:display_name] if args.key?(:display_name) @enable_fuzzy_extraction = args[:enable_fuzzy_extraction] if args.key?(:enable_fuzzy_extraction) @entities = args[:entities] if args.key?(:entities) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # This message is a wrapper around a collection of entity types. class GoogleCloudDialogflowV2EntityTypeBatch include Google::Apis::Core::Hashable # A collection of entity types. # Corresponds to the JSON property `entityTypes` # @return [Array] attr_accessor :entity_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_types = args[:entity_types] if args.key?(:entity_types) end end # An **entity entry** for an associated entity type. class GoogleCloudDialogflowV2EntityTypeEntity include Google::Apis::Core::Hashable # Required. A collection of value synonyms. For example, if the entity type # is *vegetable*, and `value` is *scallions*, a synonym could be *green # onions*. # For `KIND_LIST` entity types: # * This collection must contain exactly one synonym equal to `value`. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms # Required. The primary value associated with this entity entry. # For example, if the entity type is *vegetable*, the value could be # *scallions*. # For `KIND_MAP` entity types: # * A reference value to be used in place of synonyms. # For `KIND_LIST` entity types: # * A string that can contain references to other entity types (with or # without aliases). # Corresponds to the JSON property `value` # @return [String] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @synonyms = args[:synonyms] if args.key?(:synonyms) @value = args[:value] if args.key?(:value) end end # Represents an agent environment. class GoogleCloudDialogflowV2Environment include Google::Apis::Core::Hashable # Optional. The agent version loaded into this environment. # Format: `projects//agent/versions/`. # Corresponds to the JSON property `agentVersion` # @return [String] attr_accessor :agent_version # Optional. The developer-provided description for this environment. # The maximum length is 500 characters. If exceeded, the request is rejected. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Output only. The unique identifier of this agent environment. # Format: `projects//agent/environments/`. # For Environment ID, "-" is reserved for 'draft' environment. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The state of this environment. This field is read-only, i.e., it # cannot be # set by create and update methods. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. The last update time of this environment. This field is read-only, # i.e., it # cannot be set by create and update methods. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @agent_version = args[:agent_version] if args.key?(:agent_version) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @state = args[:state] if args.key?(:state) @update_time = args[:update_time] if args.key?(:update_time) end end # Events allow for matching intents by event name instead of the natural # language input. For instance, input `` can trigger a personalized welcome response. # The parameter `name` may be used by the agent in the response: # `"Hello #welcome_event.name! What can I do for you today?"`. class GoogleCloudDialogflowV2EventInput include Google::Apis::Core::Hashable # Required. The language of this query. See [Language # Support](https://cloud.google.com/dialogflow/docs/reference/language) # for a list of the currently supported language codes. Note that queries in # the same session do not necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Required. The unique identifier of the event. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The collection of parameters associated with the event. # Depending on your protocol or client library language, this is a # map, associative array, symbol table, dictionary, or JSON object # composed of a collection of (MapKey, MapValue) pairs: # - MapKey type: string # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @language_code = args[:language_code] if args.key?(:language_code) @name = args[:name] if args.key?(:name) @parameters = args[:parameters] if args.key?(:parameters) end end # The request message for Agents.ExportAgent. class GoogleCloudDialogflowV2ExportAgentRequest include Google::Apis::Core::Hashable # Required. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) # URI to export the agent to. # The format of this URI must be `gs:///`. # If left unspecified, the serialized agent is returned inline. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @agent_uri = args[:agent_uri] if args.key?(:agent_uri) end end # The response message for Agents.ExportAgent. class GoogleCloudDialogflowV2ExportAgentResponse include Google::Apis::Core::Hashable # Zip compressed raw byte content for agent. # Corresponds to the JSON property `agentContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :agent_content # The URI to a file containing the exported agent. This field is populated # only if `agent_uri` is specified in `ExportAgentRequest`. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @agent_content = args[:agent_content] if args.key?(:agent_content) @agent_uri = args[:agent_uri] if args.key?(:agent_uri) end end # Represents a fulfillment. class GoogleCloudDialogflowV2Fulfillment include Google::Apis::Core::Hashable # Optional. The human-readable name of the fulfillment, unique within the agent. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional. Whether fulfillment is enabled. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled alias_method :enabled?, :enabled # Optional. The field defines whether the fulfillment is enabled for certain # features. # Corresponds to the JSON property `features` # @return [Array] attr_accessor :features # Represents configuration for a generic web service. # Dialogflow supports two mechanisms for authentications: # - Basic authentication with username and password. # - Authentication with additional authentication headers. # More information could be found at: # https://cloud.google.com/dialogflow/docs/fulfillment-configure. # Corresponds to the JSON property `genericWebService` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2FulfillmentGenericWebService] attr_accessor :generic_web_service # Required. The unique identifier of the fulfillment. # Format: `projects//agent/fulfillment`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @enabled = args[:enabled] if args.key?(:enabled) @features = args[:features] if args.key?(:features) @generic_web_service = args[:generic_web_service] if args.key?(:generic_web_service) @name = args[:name] if args.key?(:name) end end # Whether fulfillment is enabled for the specific feature. class GoogleCloudDialogflowV2FulfillmentFeature include Google::Apis::Core::Hashable # The type of the feature that enabled for fulfillment. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @type = args[:type] if args.key?(:type) end end # Represents configuration for a generic web service. # Dialogflow supports two mechanisms for authentications: # - Basic authentication with username and password. # - Authentication with additional authentication headers. # More information could be found at: # https://cloud.google.com/dialogflow/docs/fulfillment-configure. class GoogleCloudDialogflowV2FulfillmentGenericWebService include Google::Apis::Core::Hashable # Optional. Indicates if generic web service is created through Cloud Functions # integration. Defaults to false. # Corresponds to the JSON property `isCloudFunction` # @return [Boolean] attr_accessor :is_cloud_function alias_method :is_cloud_function?, :is_cloud_function # Optional. The password for HTTP Basic authentication. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # Optional. The HTTP request headers to send together with fulfillment requests. # Corresponds to the JSON property `requestHeaders` # @return [Hash] attr_accessor :request_headers # Required. The fulfillment URI for receiving POST requests. # It must use https protocol. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri # Optional. The user name for HTTP Basic authentication. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @is_cloud_function = args[:is_cloud_function] if args.key?(:is_cloud_function) @password = args[:password] if args.key?(:password) @request_headers = args[:request_headers] if args.key?(:request_headers) @uri = args[:uri] if args.key?(:uri) @username = args[:username] if args.key?(:username) end end # The request message for Agents.ImportAgent. class GoogleCloudDialogflowV2ImportAgentRequest include Google::Apis::Core::Hashable # Zip compressed raw byte content for agent. # Corresponds to the JSON property `agentContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :agent_content # The URI to a Google Cloud Storage file containing the agent to import. # Note: The URI must start with "gs://". # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @agent_content = args[:agent_content] if args.key?(:agent_content) @agent_uri = args[:agent_uri] if args.key?(:agent_uri) end end # Instructs the speech recognizer how to process the audio content. class GoogleCloudDialogflowV2InputAudioConfig include Google::Apis::Core::Hashable # Required. Audio encoding of the audio content to process. # Corresponds to the JSON property `audioEncoding` # @return [String] attr_accessor :audio_encoding # If `true`, Dialogflow returns SpeechWordInfo in # StreamingRecognitionResult with information about the recognized speech # words, e.g. start and end time offsets. If false or unspecified, Speech # doesn't return any word-level information. # Corresponds to the JSON property `enableWordInfo` # @return [Boolean] attr_accessor :enable_word_info alias_method :enable_word_info?, :enable_word_info # Required. The language of the supplied audio. Dialogflow does not do # translations. See [Language # Support](https://cloud.google.com/dialogflow/docs/reference/language) # for a list of the currently supported language codes. Note that queries in # the same session do not necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Which Speech model to select for the given request. Select the # model best suited to your domain to get best results. If a model is not # explicitly specified, then we auto-select a model based on the parameters # in the InputAudioConfig. # If enhanced speech model is enabled for the agent and an enhanced # version of the specified model for the language does not exist, then the # speech is recognized using the standard version of the specified model. # Refer to # [Cloud Speech API # documentation](https://cloud.google.com/speech-to-text/docs/basics#select- # model) # for more details. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model # Which variant of the Speech model to use. # Corresponds to the JSON property `modelVariant` # @return [String] attr_accessor :model_variant # A list of strings containing words and phrases that the speech # recognizer should recognize with higher likelihood. # See [the Cloud Speech # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- # hints) # for more details. # This field is deprecated. Please use [speech_contexts]() instead. If you # specify both [phrase_hints]() and [speech_contexts](), Dialogflow will # treat the [phrase_hints]() as a single additional [SpeechContext](). # Corresponds to the JSON property `phraseHints` # @return [Array] attr_accessor :phrase_hints # Required. Sample rate (in Hertz) of the audio content sent in the query. # Refer to # [Cloud Speech API # documentation](https://cloud.google.com/speech-to-text/docs/basics) for # more details. # Corresponds to the JSON property `sampleRateHertz` # @return [Fixnum] attr_accessor :sample_rate_hertz # If `false` (default), recognition does not cease until the # client closes the stream. # If `true`, the recognizer will detect a single spoken utterance in input # audio. Recognition ceases when it detects the audio's voice has # stopped or paused. In this case, once a detected intent is received, the # client should close the stream and start a new request with a new stream as # needed. # Note: This setting is relevant only for streaming methods. # Note: When specified, InputAudioConfig.single_utterance takes precedence # over StreamingDetectIntentRequest.single_utterance. # Corresponds to the JSON property `singleUtterance` # @return [Boolean] attr_accessor :single_utterance alias_method :single_utterance?, :single_utterance # Context information to assist speech recognition. # See [the Cloud Speech # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- # hints) # for more details. # Corresponds to the JSON property `speechContexts` # @return [Array] attr_accessor :speech_contexts def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @audio_encoding = args[:audio_encoding] if args.key?(:audio_encoding) @enable_word_info = args[:enable_word_info] if args.key?(:enable_word_info) @language_code = args[:language_code] if args.key?(:language_code) @model = args[:model] if args.key?(:model) @model_variant = args[:model_variant] if args.key?(:model_variant) @phrase_hints = args[:phrase_hints] if args.key?(:phrase_hints) @sample_rate_hertz = args[:sample_rate_hertz] if args.key?(:sample_rate_hertz) @single_utterance = args[:single_utterance] if args.key?(:single_utterance) @speech_contexts = args[:speech_contexts] if args.key?(:speech_contexts) end end # Represents an intent. # Intents convert a number of user expressions or patterns into an action. An # action is an extraction of a user command or sentence semantics. class GoogleCloudDialogflowV2Intent include Google::Apis::Core::Hashable # Optional. The name of the action associated with the intent. # Note: The action name must not contain whitespaces. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Optional. The list of platforms for which the first responses will be # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). # Corresponds to the JSON property `defaultResponsePlatforms` # @return [Array] attr_accessor :default_response_platforms # Required. The name of this intent. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional. The collection of event names that trigger the intent. # If the collection of input contexts is not empty, all of the contexts must # be present in the active user session for an event to trigger this intent. # Event names are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events # Read-only. Information about all followup intents that have this intent as # a direct or indirect parent. We populate this field only in the output. # Corresponds to the JSON property `followupIntentInfo` # @return [Array] attr_accessor :followup_intent_info # Optional. The list of context names required for this intent to be # triggered. # Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `inputContextNames` # @return [Array] attr_accessor :input_context_names # Optional. Indicates whether this is a fallback intent. # Corresponds to the JSON property `isFallback` # @return [Boolean] attr_accessor :is_fallback alias_method :is_fallback?, :is_fallback # Optional. The collection of rich messages corresponding to the # `Response` field in the Dialogflow console. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages # Optional. Indicates whether Machine Learning is disabled for the intent. # Note: If `ml_disabled` setting is set to true, then this intent is not # taken into account during inference in `ML ONLY` match mode. Also, # auto-markup in the UI is turned off. # Corresponds to the JSON property `mlDisabled` # @return [Boolean] attr_accessor :ml_disabled alias_method :ml_disabled?, :ml_disabled # Optional. The unique identifier of this intent. # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents # methods. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The collection of contexts that are activated when the intent # is matched. Context messages in this collection should not set the # parameters field. Setting the `lifespan_count` to 0 will reset the context # when the intent is matched. # Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. The collection of parameters associated with the intent. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Read-only after creation. The unique identifier of the parent intent in the # chain of followup intents. You can set this field when creating an intent, # for example with CreateIntent or # BatchUpdateIntents, in order to make this # intent a followup intent. # It identifies the parent followup intent. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name # Optional. The priority of this intent. Higher numbers represent higher # priorities. # - If the supplied value is unspecified or 0, the service # translates the value to 500,000, which corresponds to the # `Normal` priority in the console. # - If the supplied value is negative, the intent is ignored # in runtime detect intent requests. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority # Optional. Indicates whether to delete all contexts in the current # session when this intent is matched. # Corresponds to the JSON property `resetContexts` # @return [Boolean] attr_accessor :reset_contexts alias_method :reset_contexts?, :reset_contexts # Read-only. The unique identifier of the root intent in the chain of # followup intents. It identifies the correct followup intents chain for # this intent. We populate this field only in the output. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `rootFollowupIntentName` # @return [String] attr_accessor :root_followup_intent_name # Optional. The collection of examples that the agent is # trained on. # Corresponds to the JSON property `trainingPhrases` # @return [Array] attr_accessor :training_phrases # Optional. Indicates whether webhooks are enabled for the intent. # Corresponds to the JSON property `webhookState` # @return [String] attr_accessor :webhook_state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms) @display_name = args[:display_name] if args.key?(:display_name) @events = args[:events] if args.key?(:events) @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info) @input_context_names = args[:input_context_names] if args.key?(:input_context_names) @is_fallback = args[:is_fallback] if args.key?(:is_fallback) @messages = args[:messages] if args.key?(:messages) @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled) @name = args[:name] if args.key?(:name) @output_contexts = args[:output_contexts] if args.key?(:output_contexts) @parameters = args[:parameters] if args.key?(:parameters) @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) @priority = args[:priority] if args.key?(:priority) @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts) @root_followup_intent_name = args[:root_followup_intent_name] if args.key?(:root_followup_intent_name) @training_phrases = args[:training_phrases] if args.key?(:training_phrases) @webhook_state = args[:webhook_state] if args.key?(:webhook_state) end end # This message is a wrapper around a collection of intents. class GoogleCloudDialogflowV2IntentBatch include Google::Apis::Core::Hashable # A collection of intents. # Corresponds to the JSON property `intents` # @return [Array] attr_accessor :intents def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @intents = args[:intents] if args.key?(:intents) end end # Represents a single followup intent in the chain. class GoogleCloudDialogflowV2IntentFollowupIntentInfo include Google::Apis::Core::Hashable # The unique identifier of the followup intent. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `followupIntentName` # @return [String] attr_accessor :followup_intent_name # The unique identifier of the followup intent's parent. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @followup_intent_name = args[:followup_intent_name] if args.key?(:followup_intent_name) @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) end end # A rich response message. # Corresponds to the intent `Response` field in the Dialogflow console. # For more information, see # [Rich response # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages). class GoogleCloudDialogflowV2IntentMessage include Google::Apis::Core::Hashable # The basic card message. Useful for displaying information. # Corresponds to the JSON property `basicCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageBasicCard] attr_accessor :basic_card # Browse Carousel Card for Actions on Google. # https://developers.google.com/actions/assistant/responses#browsing_carousel # Corresponds to the JSON property `browseCarouselCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard] attr_accessor :browse_carousel_card # The card response message. # Corresponds to the JSON property `card` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageCard] attr_accessor :card # The card for presenting a carousel of options to select from. # Corresponds to the JSON property `carouselSelect` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageCarouselSelect] attr_accessor :carousel_select # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion] attr_accessor :link_out_suggestion # The card for presenting a list of options to select from. # Corresponds to the JSON property `listSelect` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageListSelect] attr_accessor :list_select # The media content card for Actions on Google. # Corresponds to the JSON property `mediaContent` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageMediaContent] attr_accessor :media_content # A custom platform-specific response. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Optional. The platform that this message is intended for. # Corresponds to the JSON property `platform` # @return [String] attr_accessor :platform # The quick replies response message. # Corresponds to the JSON property `quickReplies` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageQuickReplies] attr_accessor :quick_replies # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageSimpleResponses] attr_accessor :simple_responses # The collection of suggestions. # Corresponds to the JSON property `suggestions` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageSuggestions] attr_accessor :suggestions # Table card for Actions on Google. # Corresponds to the JSON property `tableCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageTableCard] attr_accessor :table_card # The text response message. # Corresponds to the JSON property `text` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageText] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object 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) @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) @text = args[:text] if args.key?(:text) end end # The basic card message. Useful for displaying information. class GoogleCloudDialogflowV2IntentMessageBasicCard include Google::Apis::Core::Hashable # Optional. The collection of card buttons. # Corresponds to the JSON property `buttons` # @return [Array] attr_accessor :buttons # Required, unless image is present. The body text of the card. # Corresponds to the JSON property `formattedText` # @return [String] attr_accessor :formatted_text # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image # Optional. The subtitle of the card. # Corresponds to the JSON property `subtitle` # @return [String] attr_accessor :subtitle # Optional. The title of the card. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @buttons = args[:buttons] if args.key?(:buttons) @formatted_text = args[:formatted_text] if args.key?(:formatted_text) @image = args[:image] if args.key?(:image) @subtitle = args[:subtitle] if args.key?(:subtitle) @title = args[:title] if args.key?(:title) end end # The button object that appears at the bottom of a card. class GoogleCloudDialogflowV2IntentMessageBasicCardButton include Google::Apis::Core::Hashable # Opens the given URI. # Corresponds to the JSON property `openUriAction` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction] attr_accessor :open_uri_action # Required. The title of the button. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @open_uri_action = args[:open_uri_action] if args.key?(:open_uri_action) @title = args[:title] if args.key?(:title) end end # Opens the given URI. class GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction include Google::Apis::Core::Hashable # Required. The HTTP or HTTPS scheme URI. # 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) @uri = args[:uri] if args.key?(:uri) end end # Browse Carousel Card for Actions on Google. # https://developers.google.com/actions/assistant/responses#browsing_carousel class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard include Google::Apis::Core::Hashable # Optional. Settings for displaying the image. Applies to every image in # items. # Corresponds to the JSON property `imageDisplayOptions` # @return [String] attr_accessor :image_display_options # Required. List of items in the Browse Carousel Card. Minimum of two # items, maximum of ten. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @image_display_options = args[:image_display_options] if args.key?(:image_display_options) @items = args[:items] if args.key?(:items) end end # Browsing carousel tile class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem include Google::Apis::Core::Hashable # Optional. Description of the carousel item. Maximum of four lines of # text. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. Text that appears at the bottom of the Browse Carousel # Card. Maximum of one line of text. # Corresponds to the JSON property `footer` # @return [String] attr_accessor :footer # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image # Actions on Google action to open a given url. # Corresponds to the JSON property `openUriAction` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction] attr_accessor :open_uri_action # Required. Title of the carousel item. Maximum of two lines of text. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @footer = args[:footer] if args.key?(:footer) @image = args[:image] if args.key?(:image) @open_uri_action = args[:open_uri_action] if args.key?(:open_uri_action) @title = args[:title] if args.key?(:title) end end # Actions on Google action to open a given url. class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction include Google::Apis::Core::Hashable # Required. URL # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Optional. Specifies the type of viewer that is used when opening # the URL. Defaults to opening via web browser. # Corresponds to the JSON property `urlTypeHint` # @return [String] attr_accessor :url_type_hint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @url = args[:url] if args.key?(:url) @url_type_hint = args[:url_type_hint] if args.key?(:url_type_hint) end end # The card response message. class GoogleCloudDialogflowV2IntentMessageCard include Google::Apis::Core::Hashable # Optional. The collection of card buttons. # Corresponds to the JSON property `buttons` # @return [Array] attr_accessor :buttons # Optional. The public URI to an image file for the card. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri # Optional. The subtitle of the card. # Corresponds to the JSON property `subtitle` # @return [String] attr_accessor :subtitle # Optional. The title of the card. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @buttons = args[:buttons] if args.key?(:buttons) @image_uri = args[:image_uri] if args.key?(:image_uri) @subtitle = args[:subtitle] if args.key?(:subtitle) @title = args[:title] if args.key?(:title) end end # Contains information about a button. class GoogleCloudDialogflowV2IntentMessageCardButton include Google::Apis::Core::Hashable # Optional. The text to send back to the Dialogflow API or a URI to # open. # Corresponds to the JSON property `postback` # @return [String] attr_accessor :postback # Optional. The text to show on the button. # 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) @postback = args[:postback] if args.key?(:postback) @text = args[:text] if args.key?(:text) end end # The card for presenting a carousel of options to select from. class GoogleCloudDialogflowV2IntentMessageCarouselSelect include Google::Apis::Core::Hashable # Required. Carousel items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) end end # An item in the carousel. class GoogleCloudDialogflowV2IntentMessageCarouselSelectItem include Google::Apis::Core::Hashable # Optional. The body text of the card. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image # Additional info about the select item for when it is triggered in a # dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageSelectItemInfo] attr_accessor :info # Required. Title of the carousel item. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @image = args[:image] if args.key?(:image) @info = args[:info] if args.key?(:info) @title = args[:title] if args.key?(:title) end end # Column properties for TableCard. class GoogleCloudDialogflowV2IntentMessageColumnProperties include Google::Apis::Core::Hashable # Required. Column heading. # Corresponds to the JSON property `header` # @return [String] attr_accessor :header # Optional. Defines text alignment for all cells in this column. # Corresponds to the JSON property `horizontalAlignment` # @return [String] attr_accessor :horizontal_alignment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @header = args[:header] if args.key?(:header) @horizontal_alignment = args[:horizontal_alignment] if args.key?(:horizontal_alignment) end end # The image response message. class GoogleCloudDialogflowV2IntentMessageImage include Google::Apis::Core::Hashable # Optional. A text description of the image to be used for accessibility, # e.g., screen readers. # Corresponds to the JSON property `accessibilityText` # @return [String] attr_accessor :accessibility_text # Optional. The public URI to an image file. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accessibility_text = args[:accessibility_text] if args.key?(:accessibility_text) @image_uri = args[:image_uri] if args.key?(:image_uri) end end # The suggestion chip message that allows the user to jump out to the app # or website associated with this agent. class GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion include Google::Apis::Core::Hashable # Required. The name of the app or site this chip is linking to. # Corresponds to the JSON property `destinationName` # @return [String] attr_accessor :destination_name # Required. The URI of the app or site to open when the user taps the # suggestion chip. # 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) @destination_name = args[:destination_name] if args.key?(:destination_name) @uri = args[:uri] if args.key?(:uri) end end # The card for presenting a list of options to select from. class GoogleCloudDialogflowV2IntentMessageListSelect include Google::Apis::Core::Hashable # Required. List items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Optional. Subtitle of the list. # Corresponds to the JSON property `subtitle` # @return [String] attr_accessor :subtitle # Optional. The overall title of the list. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @subtitle = args[:subtitle] if args.key?(:subtitle) @title = args[:title] if args.key?(:title) end end # An item in the list. class GoogleCloudDialogflowV2IntentMessageListSelectItem include Google::Apis::Core::Hashable # Optional. The main text describing the item. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image # Additional info about the select item for when it is triggered in a # dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageSelectItemInfo] attr_accessor :info # Required. The title of the list item. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @image = args[:image] if args.key?(:image) @info = args[:info] if args.key?(:info) @title = args[:title] if args.key?(:title) end end # The media content card for Actions on Google. class GoogleCloudDialogflowV2IntentMessageMediaContent include Google::Apis::Core::Hashable # Required. List of media objects. # Corresponds to the JSON property `mediaObjects` # @return [Array] attr_accessor :media_objects # Optional. What type of media is the content (ie "audio"). # Corresponds to the JSON property `mediaType` # @return [String] attr_accessor :media_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @media_objects = args[:media_objects] if args.key?(:media_objects) @media_type = args[:media_type] if args.key?(:media_type) end end # Response media object for media content card. class GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject include Google::Apis::Core::Hashable # Required. Url where the media is stored. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url # Optional. Description of media card. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The image response message. # Corresponds to the JSON property `icon` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :icon # The image response message. # Corresponds to the JSON property `largeImage` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :large_image # Required. Name of media card. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_url = args[:content_url] if args.key?(:content_url) @description = args[:description] if args.key?(:description) @icon = args[:icon] if args.key?(:icon) @large_image = args[:large_image] if args.key?(:large_image) @name = args[:name] if args.key?(:name) end end # The quick replies response message. class GoogleCloudDialogflowV2IntentMessageQuickReplies include Google::Apis::Core::Hashable # Optional. The collection of quick replies. # Corresponds to the JSON property `quickReplies` # @return [Array] attr_accessor :quick_replies # Optional. The title of the collection of quick replies. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @quick_replies = args[:quick_replies] if args.key?(:quick_replies) @title = args[:title] if args.key?(:title) end end # Additional info about the select item for when it is triggered in a # dialog. class GoogleCloudDialogflowV2IntentMessageSelectItemInfo include Google::Apis::Core::Hashable # Required. A unique key that will be sent back to the agent if this # response is given. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # Optional. A list of synonyms that can also be used to trigger this # item in dialog. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key = args[:key] if args.key?(:key) @synonyms = args[:synonyms] if args.key?(:synonyms) end end # The simple response message containing speech or text. class GoogleCloudDialogflowV2IntentMessageSimpleResponse include Google::Apis::Core::Hashable # Optional. The text to display. # Corresponds to the JSON property `displayText` # @return [String] attr_accessor :display_text # One of text_to_speech or ssml must be provided. Structured spoken # response to the user in the SSML format. Mutually exclusive with # text_to_speech. # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml # One of text_to_speech or ssml must be provided. The plain text of the # speech output. Mutually exclusive with ssml. # Corresponds to the JSON property `textToSpeech` # @return [String] attr_accessor :text_to_speech def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_text = args[:display_text] if args.key?(:display_text) @ssml = args[:ssml] if args.key?(:ssml) @text_to_speech = args[:text_to_speech] if args.key?(:text_to_speech) end end # The collection of simple response candidates. # This message in `QueryResult.fulfillment_messages` and # `WebhookResponse.fulfillment_messages` should contain only one # `SimpleResponse`. class GoogleCloudDialogflowV2IntentMessageSimpleResponses include Google::Apis::Core::Hashable # Required. The list of simple responses. # Corresponds to the JSON property `simpleResponses` # @return [Array] attr_accessor :simple_responses def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @simple_responses = args[:simple_responses] if args.key?(:simple_responses) end end # The suggestion chip message that the user can tap to quickly post a reply # to the conversation. class GoogleCloudDialogflowV2IntentMessageSuggestion include Google::Apis::Core::Hashable # Required. The text shown the in the suggestion chip. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @title = args[:title] if args.key?(:title) end end # The collection of suggestions. class GoogleCloudDialogflowV2IntentMessageSuggestions include Google::Apis::Core::Hashable # Required. The list of suggested replies. # Corresponds to the JSON property `suggestions` # @return [Array] attr_accessor :suggestions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @suggestions = args[:suggestions] if args.key?(:suggestions) end end # Table card for Actions on Google. class GoogleCloudDialogflowV2IntentMessageTableCard include Google::Apis::Core::Hashable # Optional. List of buttons for the card. # Corresponds to the JSON property `buttons` # @return [Array] attr_accessor :buttons # Optional. Display properties for the columns in this table. # Corresponds to the JSON property `columnProperties` # @return [Array] attr_accessor :column_properties # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image # Optional. Rows in this table of data. # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows # Optional. Subtitle to the title. # Corresponds to the JSON property `subtitle` # @return [String] attr_accessor :subtitle # Required. Title of the card. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @buttons = args[:buttons] if args.key?(:buttons) @column_properties = args[:column_properties] if args.key?(:column_properties) @image = args[:image] if args.key?(:image) @rows = args[:rows] if args.key?(:rows) @subtitle = args[:subtitle] if args.key?(:subtitle) @title = args[:title] if args.key?(:title) end end # Cell of TableCardRow. class GoogleCloudDialogflowV2IntentMessageTableCardCell include Google::Apis::Core::Hashable # Required. Text in this cell. # 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) @text = args[:text] if args.key?(:text) end end # Row of TableCard. class GoogleCloudDialogflowV2IntentMessageTableCardRow include Google::Apis::Core::Hashable # Optional. List of cells that make up this row. # Corresponds to the JSON property `cells` # @return [Array] attr_accessor :cells # Optional. Whether to add a visual divider after this row. # Corresponds to the JSON property `dividerAfter` # @return [Boolean] attr_accessor :divider_after alias_method :divider_after?, :divider_after def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cells = args[:cells] if args.key?(:cells) @divider_after = args[:divider_after] if args.key?(:divider_after) end end # The text response message. class GoogleCloudDialogflowV2IntentMessageText include Google::Apis::Core::Hashable # Optional. The collection of the agent's responses. # Corresponds to the JSON property `text` # @return [Array] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @text = args[:text] if args.key?(:text) end end # Represents intent parameters. class GoogleCloudDialogflowV2IntentParameter include Google::Apis::Core::Hashable # Optional. The default value to use when the `value` yields an empty # result. # Default values can be extracted from contexts by using the following # syntax: `#context_name.parameter_name`. # Corresponds to the JSON property `defaultValue` # @return [String] attr_accessor :default_value # Required. The name of the parameter. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional. The name of the entity type, prefixed with `@`, that # describes values of the parameter. If the parameter is # required, this must be provided. # Corresponds to the JSON property `entityTypeDisplayName` # @return [String] attr_accessor :entity_type_display_name # Optional. Indicates whether the parameter represents a list of values. # Corresponds to the JSON property `isList` # @return [Boolean] attr_accessor :is_list alias_method :is_list?, :is_list # Optional. Indicates whether the parameter is required. That is, # whether the intent cannot be completed without collecting the parameter # value. # Corresponds to the JSON property `mandatory` # @return [Boolean] attr_accessor :mandatory alias_method :mandatory?, :mandatory # The unique identifier of this parameter. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The collection of prompts that the agent can present to the # user in order to collect a value for the parameter. # Corresponds to the JSON property `prompts` # @return [Array] attr_accessor :prompts # Optional. The definition of the parameter value. It can be: # - a constant string, # - a parameter value defined as `$parameter_name`, # - an original parameter value defined as `$parameter_name.original`, # - a parameter value from some context defined as # `#context_name.parameter_name`. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_value = args[:default_value] if args.key?(:default_value) @display_name = args[:display_name] if args.key?(:display_name) @entity_type_display_name = args[:entity_type_display_name] if args.key?(:entity_type_display_name) @is_list = args[:is_list] if args.key?(:is_list) @mandatory = args[:mandatory] if args.key?(:mandatory) @name = args[:name] if args.key?(:name) @prompts = args[:prompts] if args.key?(:prompts) @value = args[:value] if args.key?(:value) end end # Represents an example that the agent is trained on. class GoogleCloudDialogflowV2IntentTrainingPhrase include Google::Apis::Core::Hashable # Output only. The unique identifier of this training phrase. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The ordered list of training phrase parts. # The parts are concatenated in order to form the training phrase. # Note: The API does not automatically annotate training phrases like the # Dialogflow Console does. # Note: Do not forget to include whitespace at part boundaries, # so the training phrase is well formatted when the parts are concatenated. # If the training phrase does not need to be annotated with parameters, # you just need a single part with only the Part.text field set. # If you want to annotate the training phrase, you must create multiple # parts, where the fields of each part are populated in one of two ways: # - `Part.text` is set to a part of the phrase that has no parameters. # - `Part.text` is set to a part of the phrase that you want to annotate, # and the `entity_type`, `alias`, and `user_defined` fields are all # set. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts # Optional. Indicates how many times this example was added to # the intent. Each time a developer adds an existing sample by editing an # intent or training, this counter is increased. # Corresponds to the JSON property `timesAddedCount` # @return [Fixnum] attr_accessor :times_added_count # Required. The type of the training phrase. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @parts = args[:parts] if args.key?(:parts) @times_added_count = args[:times_added_count] if args.key?(:times_added_count) @type = args[:type] if args.key?(:type) end end # Represents a part of a training phrase. class GoogleCloudDialogflowV2IntentTrainingPhrasePart include Google::Apis::Core::Hashable # Optional. The parameter name for the value extracted from the # annotated part of the example. # This field is required for annotated parts of the training phrase. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias # Optional. The entity type name prefixed with `@`. # This field is required for annotated parts of the training phrase. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type # Required. The text for this part. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text # Optional. Indicates whether the text was manually annotated. # This field is set to true when the Dialogflow Console is used to # manually annotate the part. When creating an annotated part with the # API, you must set this to true. # Corresponds to the JSON property `userDefined` # @return [Boolean] attr_accessor :user_defined alias_method :user_defined?, :user_defined def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alias = args[:alias] if args.key?(:alias) @entity_type = args[:entity_type] if args.key?(:entity_type) @text = args[:text] if args.key?(:text) @user_defined = args[:user_defined] if args.key?(:user_defined) end end # The response message for Contexts.ListContexts. class GoogleCloudDialogflowV2ListContextsResponse include Google::Apis::Core::Hashable # The list of contexts. There will be a maximum number of items # returned based on the page_size field in the request. # Corresponds to the JSON property `contexts` # @return [Array] attr_accessor :contexts # Token to retrieve the next page of results, or empty if there are no # more results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contexts = args[:contexts] if args.key?(:contexts) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for EntityTypes.ListEntityTypes. class GoogleCloudDialogflowV2ListEntityTypesResponse include Google::Apis::Core::Hashable # The list of agent entity types. There will be a maximum number of items # returned based on the page_size field in the request. # Corresponds to the JSON property `entityTypes` # @return [Array] attr_accessor :entity_types # Token to retrieve the next page of results, or empty if there are no # more results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_types = args[:entity_types] if args.key?(:entity_types) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Environments.ListEnvironments. class GoogleCloudDialogflowV2ListEnvironmentsResponse include Google::Apis::Core::Hashable # The list of agent environments. There will be a maximum number of items # returned based on the page_size field in the request. # Corresponds to the JSON property `environments` # @return [Array] attr_accessor :environments # Token to retrieve the next page of results, or empty if there are no # more results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @environments = args[:environments] if args.key?(:environments) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for Intents.ListIntents. class GoogleCloudDialogflowV2ListIntentsResponse include Google::Apis::Core::Hashable # The list of agent intents. There will be a maximum number of items # returned based on the page_size field in the request. # Corresponds to the JSON property `intents` # @return [Array] attr_accessor :intents # Token to retrieve the next page of results, or empty if there are no # more results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @intents = args[:intents] if args.key?(:intents) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The response message for SessionEntityTypes.ListSessionEntityTypes. class GoogleCloudDialogflowV2ListSessionEntityTypesResponse include Google::Apis::Core::Hashable # Token to retrieve the next page of results, or empty if there are no # more results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of session entity types. There will be a maximum number of items # returned based on the page_size field in the request. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) end end # Represents a message posted into a conversation. class GoogleCloudDialogflowV2Message include Google::Apis::Core::Hashable # Required. The message content. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # Output only. The time when the message was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Optional. The message language. # This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) # language tag. Example: "en-US". # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Represents the result of annotation for the message. # Corresponds to the JSON property `messageAnnotation` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2MessageAnnotation] attr_accessor :message_annotation # The unique identifier of the message. # Format: `projects//conversations//messages/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The participant that sends this message. # Corresponds to the JSON property `participant` # @return [String] attr_accessor :participant # Output only. The role of the participant. # Corresponds to the JSON property `participantRole` # @return [String] attr_accessor :participant_role def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) @create_time = args[:create_time] if args.key?(:create_time) @language_code = args[:language_code] if args.key?(:language_code) @message_annotation = args[:message_annotation] if args.key?(:message_annotation) @name = args[:name] if args.key?(:name) @participant = args[:participant] if args.key?(:participant) @participant_role = args[:participant_role] if args.key?(:participant_role) end end # Represents the result of annotation for the message. class GoogleCloudDialogflowV2MessageAnnotation include Google::Apis::Core::Hashable # Indicates whether the text message contains entities. # Corresponds to the JSON property `containEntities` # @return [Boolean] attr_accessor :contain_entities alias_method :contain_entities?, :contain_entities # The collection of annotated message parts ordered by their # position in the message. You can recover the annotated message by # concatenating [AnnotatedMessagePart.text]. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contain_entities = args[:contain_entities] if args.key?(:contain_entities) @parts = args[:parts] if args.key?(:parts) end end # Represents the contents of the original request that was passed to # the `[Streaming]DetectIntent` call. class GoogleCloudDialogflowV2OriginalDetectIntentRequest include Google::Apis::Core::Hashable # Optional. This field is set to the value of the `QueryParameters.payload` # field passed in the request. Some integrations that query a Dialogflow # agent may provide additional information in the payload. # In particular, for the Dialogflow Phone Gateway integration, this field has # the form: #
`
        # "telephony": `
        # "caller_id": "+18558363987"
        # `
        # `
# Note: The caller ID field (`caller_id`) will be redacted for Standard # Edition agents and populated with the caller ID in [E.164 # format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # The source of this request, e.g., `google`, `facebook`, `slack`. It is set # by Dialogflow-owned servers. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # Optional. The version of the protocol used for this request. # This field is AoG-specific. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @payload = args[:payload] if args.key?(:payload) @source = args[:source] if args.key?(:source) @version = args[:version] if args.key?(:version) end end # Instructs the speech synthesizer on how to generate the output audio content. # If this audio config is supplied in a request, it overrides all existing # text-to-speech settings applied to the agent. class GoogleCloudDialogflowV2OutputAudioConfig include Google::Apis::Core::Hashable # Required. Audio encoding of the synthesized audio content. # Corresponds to the JSON property `audioEncoding` # @return [String] attr_accessor :audio_encoding # The synthesis sample rate (in hertz) for this audio. If not # provided, then the synthesizer will use the default sample rate based on # the audio encoding. If this is different from the voice's natural sample # rate, then the synthesizer will honor this request by converting to the # desired sample rate (which might result in worse audio quality). # Corresponds to the JSON property `sampleRateHertz` # @return [Fixnum] attr_accessor :sample_rate_hertz # Configuration of how speech should be synthesized. # Corresponds to the JSON property `synthesizeSpeechConfig` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SynthesizeSpeechConfig] attr_accessor :synthesize_speech_config def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @audio_encoding = args[:audio_encoding] if args.key?(:audio_encoding) @sample_rate_hertz = args[:sample_rate_hertz] if args.key?(:sample_rate_hertz) @synthesize_speech_config = args[:synthesize_speech_config] if args.key?(:synthesize_speech_config) end end # Represents the query input. It can contain either: # 1. An audio config which # instructs the speech recognizer how to process the speech audio. # 2. A conversational query in the form of text,. # 3. An event that specifies which intent to trigger. class GoogleCloudDialogflowV2QueryInput include Google::Apis::Core::Hashable # Instructs the speech recognizer how to process the audio content. # Corresponds to the JSON property `audioConfig` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2InputAudioConfig] attr_accessor :audio_config # Events allow for matching intents by event name instead of the natural # language input. For instance, input `` can trigger a personalized welcome response. # The parameter `name` may be used by the agent in the response: # `"Hello #welcome_event.name! What can I do for you today?"`. # Corresponds to the JSON property `event` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EventInput] attr_accessor :event # Represents the natural language text to be processed. # Corresponds to the JSON property `text` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TextInput] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @audio_config = args[:audio_config] if args.key?(:audio_config) @event = args[:event] if args.key?(:event) @text = args[:text] if args.key?(:text) end end # Represents the parameters of the conversational query. class GoogleCloudDialogflowV2QueryParameters include Google::Apis::Core::Hashable # The collection of contexts to be activated before this query is # executed. # Corresponds to the JSON property `contexts` # @return [Array] attr_accessor :contexts # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. # Corresponds to the JSON property `geoLocation` # @return [Google::Apis::DialogflowV2::GoogleTypeLatLng] attr_accessor :geo_location # This field can be used to pass custom data to your webhook. # Arbitrary JSON objects are supported. # If supplied, the value is used to populate the # `WebhookRequest.original_detect_intent_request.payload` # field sent to your webhook. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Specifies whether to delete all contexts in the current session # before the new ones are activated. # Corresponds to the JSON property `resetContexts` # @return [Boolean] attr_accessor :reset_contexts alias_method :reset_contexts?, :reset_contexts # Configures the types of sentiment analysis to perform. # Corresponds to the JSON property `sentimentAnalysisRequestConfig` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisRequestConfig] attr_accessor :sentiment_analysis_request_config # Additional session entity types to replace or extend developer # entity types with. The entity synonyms apply to all languages and persist # for the session of this query. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types # The time zone of this conversational query from the # [time zone database](https://www.iana.org/time-zones), e.g., # America/New_York, Europe/Paris. If not provided, the time zone specified in # agent settings is used. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @contexts = args[:contexts] if args.key?(:contexts) @geo_location = args[:geo_location] if args.key?(:geo_location) @payload = args[:payload] if args.key?(:payload) @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts) @sentiment_analysis_request_config = args[:sentiment_analysis_request_config] if args.key?(:sentiment_analysis_request_config) @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) @time_zone = args[:time_zone] if args.key?(:time_zone) end end # Represents the result of conversational query or event processing. class GoogleCloudDialogflowV2QueryResult include Google::Apis::Core::Hashable # The action name from the matched intent. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # This field is set to: # - `false` if the matched intent has required parameters and not all of # the required parameter values have been collected. # - `true` if all required parameter values have been collected, or if the # matched intent doesn't contain any required parameters. # Corresponds to the JSON property `allRequiredParamsPresent` # @return [Boolean] attr_accessor :all_required_params_present alias_method :all_required_params_present?, :all_required_params_present # Free-form diagnostic information for the associated detect intent request. # The fields of this data can change without notice, so you should not write # code that depends on its structure. # The data may contain: # - webhook call latency # - webhook errors # Corresponds to the JSON property `diagnosticInfo` # @return [Hash] attr_accessor :diagnostic_info # The collection of rich messages to present to the user. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages # The text to be pronounced to the user or shown on the screen. # Note: This is a legacy field, `fulfillment_messages` should be preferred. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text # Represents an intent. # Intents convert a number of user expressions or patterns into an action. An # action is an extraction of a user command or sentence semantics. # Corresponds to the JSON property `intent` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent] attr_accessor :intent # The intent detection confidence. Values range from 0.0 # (completely uncertain) to 1.0 (completely certain). # This value is for informational purpose only and is only used to # help match the best intent within the classification threshold. # This value may change for the same end-user expression at any time due to a # model retraining or change in implementation. # If there are `multiple knowledge_answers` messages, this value is set to # the greatest `knowledgeAnswers.match_confidence` value in the list. # Corresponds to the JSON property `intentDetectionConfidence` # @return [Float] attr_accessor :intent_detection_confidence # The language that was triggered during intent detection. # See [Language # Support](https://cloud.google.com/dialogflow/docs/reference/language) # for a list of the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # The collection of output contexts. If applicable, # `output_contexts.parameters` contains entries with name # `.original` containing the original parameter values # before the query. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # The collection of extracted parameters. # Depending on your protocol or client library language, this is a # map, associative array, symbol table, dictionary, or JSON object # composed of a collection of (MapKey, MapValue) pairs: # - MapKey type: string # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters # The original conversational query text: # - If natural language text was provided as input, `query_text` contains # a copy of the input. # - If natural language speech audio was provided as input, `query_text` # contains the speech recognition result. If speech recognizer produced # multiple alternatives, a particular one is picked. # - If automatic spell correction is enabled, `query_text` will contain the # corrected user input. # Corresponds to the JSON property `queryText` # @return [String] attr_accessor :query_text # 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 # The Speech recognition confidence between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are # correct. The default of 0.0 is a sentinel value indicating that confidence # was not set. # This field is not guaranteed to be accurate or set. In particular this # field isn't set for StreamingDetectIntent since the streaming endpoint has # separate confidence estimates per portion of the audio in # StreamingRecognitionResult. # Corresponds to the JSON property `speechRecognitionConfidence` # @return [Float] attr_accessor :speech_recognition_confidence # If the query was fulfilled by a webhook call, this field is set to the # value of the `payload` field returned in the webhook response. # Corresponds to the JSON property `webhookPayload` # @return [Hash] attr_accessor :webhook_payload # If the query was fulfilled by a webhook call, this field is set to the # value of the `source` field returned in the webhook response. # Corresponds to the JSON property `webhookSource` # @return [String] attr_accessor :webhook_source def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @all_required_params_present = args[:all_required_params_present] if args.key?(:all_required_params_present) @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info) @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) @intent = args[:intent] if args.key?(:intent) @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence) @language_code = args[:language_code] if args.key?(:language_code) @output_contexts = args[:output_contexts] if args.key?(:output_contexts) @parameters = args[:parameters] if args.key?(:parameters) @query_text = args[:query_text] if args.key?(:query_text) @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result) @speech_recognition_confidence = args[:speech_recognition_confidence] if args.key?(:speech_recognition_confidence) @webhook_payload = args[:webhook_payload] if args.key?(:webhook_payload) @webhook_source = args[:webhook_source] if args.key?(:webhook_source) end end # The request message for Agents.RestoreAgent. class GoogleCloudDialogflowV2RestoreAgentRequest include Google::Apis::Core::Hashable # Zip compressed raw byte content for agent. # Corresponds to the JSON property `agentContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :agent_content # The URI to a Google Cloud Storage file containing the agent to restore. # Note: The URI must start with "gs://". # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @agent_content = args[:agent_content] if args.key?(:agent_content) @agent_uri = args[:agent_uri] if args.key?(:agent_uri) end end # The response message for Agents.SearchAgents. class GoogleCloudDialogflowV2SearchAgentsResponse include Google::Apis::Core::Hashable # The list of agents. There will be a maximum number of items returned based # on the page_size field in the request. # Corresponds to the JSON property `agents` # @return [Array] attr_accessor :agents # Token to retrieve the next page of results, or empty if there are no # more results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @agents = args[:agents] if args.key?(:agents) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # The sentiment, such as positive/negative feeling or association, for a unit # of analysis, such as the query text. class GoogleCloudDialogflowV2Sentiment include Google::Apis::Core::Hashable # A non-negative number in the [0, +inf) range, which represents the absolute # magnitude of sentiment, regardless of score (positive or negative). # Corresponds to the JSON property `magnitude` # @return [Float] attr_accessor :magnitude # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @magnitude = args[:magnitude] if args.key?(:magnitude) @score = args[:score] if args.key?(:score) end end # Configures the types of sentiment analysis to perform. class GoogleCloudDialogflowV2SentimentAnalysisRequestConfig include Google::Apis::Core::Hashable # Instructs the service to perform sentiment analysis on # `query_text`. If not provided, sentiment analysis is not performed on # `query_text`. # Corresponds to the JSON property `analyzeQueryTextSentiment` # @return [Boolean] attr_accessor :analyze_query_text_sentiment alias_method :analyze_query_text_sentiment?, :analyze_query_text_sentiment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @analyze_query_text_sentiment = args[:analyze_query_text_sentiment] if args.key?(:analyze_query_text_sentiment) end end # 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 # The sentiment, such as positive/negative feeling or association, for a unit # of analysis, such as the query text. # Corresponds to the JSON property `queryTextSentiment` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Sentiment] attr_accessor :query_text_sentiment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @query_text_sentiment = args[:query_text_sentiment] if args.key?(:query_text_sentiment) end end # Represents a session entity type. # Extends or replaces a custom entity type at the user session level (we # refer to the entity types defined at the agent level as "custom entity # types"). # Note: session entity types apply to all queries, regardless of the language. class GoogleCloudDialogflowV2SessionEntityType include Google::Apis::Core::Hashable # Required. The collection of entities associated with this session entity # type. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # Required. Indicates whether the additional data should override or # supplement the custom entity type definition. # Corresponds to the JSON property `entityOverrideMode` # @return [String] attr_accessor :entity_override_mode # Required. The unique identifier of this session entity type. Format: # `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. # If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # `` must be the display name of an existing entity # type in the same agent that will be overridden or supplemented. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entities = args[:entities] if args.key?(:entities) @entity_override_mode = args[:entity_override_mode] if args.key?(:entity_override_mode) @name = args[:name] if args.key?(:name) end end # Hints for the speech recognizer to help with recognition in a specific # conversation state. class GoogleCloudDialogflowV2SpeechContext include Google::Apis::Core::Hashable # Optional. Boost for this context compared to other contexts: # * If the boost is positive, Dialogflow will increase the probability that # the phrases in this context are recognized over similar sounding phrases. # * If the boost is unspecified or non-positive, Dialogflow will not apply # any boost. # Dialogflow recommends that you use boosts in the range (0, 20] and that you # find a value that fits your use case with binary search. # Corresponds to the JSON property `boost` # @return [Float] attr_accessor :boost # Optional. A list of strings containing words and phrases that the speech # recognizer should recognize with higher likelihood. # This list can be used to: # * improve accuracy for words and phrases you expect the user to say, # e.g. typical commands for your Dialogflow agent # * add additional words to the speech recognizer vocabulary # * ... # See the [Cloud Speech # documentation](https://cloud.google.com/speech-to-text/quotas) for usage # limits. # Corresponds to the JSON property `phrases` # @return [Array] attr_accessor :phrases def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @boost = args[:boost] if args.key?(:boost) @phrases = args[:phrases] if args.key?(:phrases) end end # Configuration of how speech should be synthesized. class GoogleCloudDialogflowV2SynthesizeSpeechConfig include Google::Apis::Core::Hashable # Optional. An identifier which selects 'audio effects' profiles that are # applied on (post synthesized) text to speech. Effects are applied on top of # each other in the order they are given. # Corresponds to the JSON property `effectsProfileId` # @return [Array] attr_accessor :effects_profile_id # Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 # semitones from the original pitch. -20 means decrease 20 semitones from the # original pitch. # Corresponds to the JSON property `pitch` # @return [Float] attr_accessor :pitch # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal # native speed supported by the specific voice. 2.0 is twice as fast, and # 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any # other values < 0.25 or > 4.0 will return an error. # Corresponds to the JSON property `speakingRate` # @return [Float] attr_accessor :speaking_rate # Description of which voice to use for speech synthesis. # Corresponds to the JSON property `voice` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2VoiceSelectionParams] attr_accessor :voice # Optional. Volume gain (in dB) of the normal native volume supported by the # specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of # 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) # will play at approximately half the amplitude of the normal native signal # amplitude. A value of +6.0 (dB) will play at approximately twice the # amplitude of the normal native signal amplitude. We strongly recommend not # to exceed +10 (dB) as there's usually no effective increase in loudness for # any value greater than that. # Corresponds to the JSON property `volumeGainDb` # @return [Float] attr_accessor :volume_gain_db def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @effects_profile_id = args[:effects_profile_id] if args.key?(:effects_profile_id) @pitch = args[:pitch] if args.key?(:pitch) @speaking_rate = args[:speaking_rate] if args.key?(:speaking_rate) @voice = args[:voice] if args.key?(:voice) @volume_gain_db = args[:volume_gain_db] if args.key?(:volume_gain_db) end end # Represents the natural language text to be processed. class GoogleCloudDialogflowV2TextInput include Google::Apis::Core::Hashable # Required. The language of this conversational query. See [Language # Support](https://cloud.google.com/dialogflow/docs/reference/language) # for a list of the currently supported language codes. Note that queries in # the same session do not necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Required. The UTF-8 encoded natural language text to be processed. # Text length must not exceed 256 characters. # 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) @language_code = args[:language_code] if args.key?(:language_code) @text = args[:text] if args.key?(:text) end end # The request message for Agents.TrainAgent. class GoogleCloudDialogflowV2TrainAgentRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Represents a single validation error. class GoogleCloudDialogflowV2ValidationError include Google::Apis::Core::Hashable # The names of the entries that the error is associated with. # Format: # - "projects//agent", if the error is associated with the entire # agent. # - "projects//agent/intents/", if the error is # associated with certain intents. # - "projects//agent/intents//trainingPhrases/", if the # error is associated with certain intent training phrases. # - "projects//agent/intents//parameters/", if the error is associated with certain intent parameters. # - "projects//agent/entities/", if the error is # associated with certain entities. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries # The detailed error messsage. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message # The severity of the error. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entries = args[:entries] if args.key?(:entries) @error_message = args[:error_message] if args.key?(:error_message) @severity = args[:severity] if args.key?(:severity) end end # Represents the output of agent validation. class GoogleCloudDialogflowV2ValidationResult include Google::Apis::Core::Hashable # Contains all validation errors. # Corresponds to the JSON property `validationErrors` # @return [Array] attr_accessor :validation_errors def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @validation_errors = args[:validation_errors] if args.key?(:validation_errors) end end # Description of which voice to use for speech synthesis. class GoogleCloudDialogflowV2VoiceSelectionParams include Google::Apis::Core::Hashable # Optional. The name of the voice. If not set, the service will choose a # voice based on the other parameters such as language_code and # ssml_gender. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The preferred gender of the voice. If not set, the service will # choose a voice based on the other parameters such as language_code and # name. Note that this is only a preference, not requirement. If a # voice of the appropriate gender is not available, the synthesizer should # substitute a voice with a different gender rather than failing the request. # Corresponds to the JSON property `ssmlGender` # @return [String] attr_accessor :ssml_gender def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @ssml_gender = args[:ssml_gender] if args.key?(:ssml_gender) end end # The request message for a webhook call. class GoogleCloudDialogflowV2WebhookRequest include Google::Apis::Core::Hashable # Represents the contents of the original request that was passed to # the `[Streaming]DetectIntent` call. # Corresponds to the JSON property `originalDetectIntentRequest` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OriginalDetectIntentRequest] attr_accessor :original_detect_intent_request # Represents the result of conversational query or event processing. # Corresponds to the JSON property `queryResult` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryResult] attr_accessor :query_result # The unique identifier of the response. Contains the same value as # `[Streaming]DetectIntentResponse.response_id`. # Corresponds to the JSON property `responseId` # @return [String] attr_accessor :response_id # The unique identifier of detectIntent request session. # Can be used to identify end-user inside webhook implementation. # Format: `projects//agent/sessions/`, or # `projects//agent/environments//users//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @original_detect_intent_request = args[:original_detect_intent_request] if args.key?(:original_detect_intent_request) @query_result = args[:query_result] if args.key?(:query_result) @response_id = args[:response_id] if args.key?(:response_id) @session = args[:session] if args.key?(:session) end end # The response message for a webhook call. # This response is validated by the Dialogflow server. If validation fails, # an error will be returned in the QueryResult.diagnostic_info field. # Setting JSON fields to an empty value with the wrong type is a common error. # To avoid this error: # - Use `""` for empty strings # - Use ```` or `null` for empty objects # - Use `[]` or `null` for empty arrays # For more information, see the # [Protocol Buffers Language # Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). class GoogleCloudDialogflowV2WebhookResponse include Google::Apis::Core::Hashable # Events allow for matching intents by event name instead of the natural # language input. For instance, input `` can trigger a personalized welcome response. # The parameter `name` may be used by the agent in the response: # `"Hello #welcome_event.name! What can I do for you today?"`. # Corresponds to the JSON property `followupEventInput` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EventInput] attr_accessor :followup_event_input # Optional. The rich response messages intended for the end-user. # When provided, Dialogflow uses this field to populate # QueryResult.fulfillment_messages sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages # Optional. The text response message intended for the end-user. # It is recommended to use `fulfillment_messages.text.text[0]` instead. # When provided, Dialogflow uses this field to populate # QueryResult.fulfillment_text sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text # Optional. The collection of output contexts that will overwrite currently # active contexts for the session and reset their lifespans. # When provided, Dialogflow uses this field to populate # QueryResult.output_contexts sent to the integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the # integration or API caller. Arbitrary JSON objects are supported. # When provided, Dialogflow uses this field to populate # QueryResult.webhook_payload sent to the integration or API caller. # This field is also used by the # [Google Assistant # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) # for rich response messages. # See the format definition at [Google Assistant Dialogflow webhook # format](https://developers.google.com/assistant/actions/build/json/dialogflow- # webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Optional. Additional session entity types to replace or extend developer # entity types with. The entity synonyms apply to all languages and persist # for the session. Setting this data from a webhook overwrites # the session entity types that have been set using `detectIntent`, # `streamingDetectIntent` or SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types # Optional. A custom field used to identify the webhook source. # Arbitrary strings are supported. # When provided, Dialogflow uses this field to populate # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input) @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) @output_contexts = args[:output_contexts] if args.key?(:output_contexts) @payload = args[:payload] if args.key?(:payload) @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) @source = args[:source] if args.key?(:source) end end # Represents an annotated conversation dataset. # ConversationDataset can have multiple AnnotatedConversationDataset, each of # them represents one result from one annotation task. # AnnotatedConversationDataset can only be generated from annotation task, # which will be triggered by LabelConversation. class GoogleCloudDialogflowV2beta1AnnotatedConversationDataset include Google::Apis::Core::Hashable # Output only. Number of examples that have annotations in the annotated # conversation dataset. # Corresponds to the JSON property `completedExampleCount` # @return [Fixnum] attr_accessor :completed_example_count # Output only. Creation time of this annotated conversation dataset. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Optional. The description of the annotated conversation dataset. # Maximum of 10000 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Required. The display name of the annotated conversation dataset. # It's specified when user starts an annotation task. Maximum of 64 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Output only. Number of examples in the annotated conversation dataset. # Corresponds to the JSON property `exampleCount` # @return [Fixnum] attr_accessor :example_count # Output only. AnnotatedConversationDataset resource name. Format: # `projects//conversationDatasets//annotatedConversationDatasets/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. Question type name that identifies a labeling task. # A question is a single task that a worker answers. A question type is set # of related questions. Each question belongs to a particular question type. # It can be used in CrowdCompute UI to filter and manage labeling tasks. # Corresponds to the JSON property `questionTypeName` # @return [String] attr_accessor :question_type_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @completed_example_count = args[:completed_example_count] if args.key?(:completed_example_count) @create_time = args[:create_time] if args.key?(:create_time) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @example_count = args[:example_count] if args.key?(:example_count) @name = args[:name] if args.key?(:name) @question_type_name = args[:question_type_name] if args.key?(:question_type_name) end end # The response message for EntityTypes.BatchUpdateEntityTypes. class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse include Google::Apis::Core::Hashable # The collection of updated or created entity types. # Corresponds to the JSON property `entityTypes` # @return [Array] attr_accessor :entity_types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_types = args[:entity_types] if args.key?(:entity_types) end end # The response message for Intents.BatchUpdateIntents. class GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse include Google::Apis::Core::Hashable # The collection of updated or created intents. # Corresponds to the JSON property `intents` # @return [Array] attr_accessor :intents def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @intents = args[:intents] if args.key?(:intents) end end # Represents a context. class GoogleCloudDialogflowV2beta1Context include Google::Apis::Core::Hashable # Optional. The number of conversational query requests after which the # context expires. The default is `0`. If set to `0`, the context expires # immediately. Contexts expire automatically after 20 minutes if there # are no matching queries. # Corresponds to the JSON property `lifespanCount` # @return [Fixnum] attr_accessor :lifespan_count # Required. The unique identifier of the context. Format: # `projects//agent/sessions//contexts/`, # or `projects//agent/environments//users//sessions//contexts/`. # The `Context ID` is always converted to lowercase, may only contain # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. # If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # The following context names are reserved for internal use by Dialogflow. # You should not use these contexts or create contexts with these names: # * `__system_counters__` # * `*_id_dialog_context` # * `*_dialog_params_size` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The collection of parameters associated with this context. # Depending on your protocol or client library language, this is a # map, associative array, symbol table, dictionary, or JSON object # composed of a collection of (MapKey, MapValue) pairs: # - MapKey type: string # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @lifespan_count = args[:lifespan_count] if args.key?(:lifespan_count) @name = args[:name] if args.key?(:name) @parameters = args[:parameters] if args.key?(:parameters) end end # Represents an entity type. # Entity types serve as a tool for extracting parameter values from natural # language queries. class GoogleCloudDialogflowV2beta1EntityType include Google::Apis::Core::Hashable # Optional. Indicates whether the entity type can be automatically # expanded. # Corresponds to the JSON property `autoExpansionMode` # @return [String] attr_accessor :auto_expansion_mode # Required. The name of the entity type. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional. Enables fuzzy entity extraction during classification. # Corresponds to the JSON property `enableFuzzyExtraction` # @return [Boolean] attr_accessor :enable_fuzzy_extraction alias_method :enable_fuzzy_extraction?, :enable_fuzzy_extraction # Optional. The collection of entity entries associated with the entity type. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # Required. Indicates the kind of entity type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The unique identifier of the entity type. # Required for EntityTypes.UpdateEntityType and # EntityTypes.BatchUpdateEntityTypes methods. # Format: `projects//agent/entityTypes/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @auto_expansion_mode = args[:auto_expansion_mode] if args.key?(:auto_expansion_mode) @display_name = args[:display_name] if args.key?(:display_name) @enable_fuzzy_extraction = args[:enable_fuzzy_extraction] if args.key?(:enable_fuzzy_extraction) @entities = args[:entities] if args.key?(:entities) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # An **entity entry** for an associated entity type. class GoogleCloudDialogflowV2beta1EntityTypeEntity include Google::Apis::Core::Hashable # Required. A collection of value synonyms. For example, if the entity type # is *vegetable*, and `value` is *scallions*, a synonym could be *green # onions*. # For `KIND_LIST` entity types: # * This collection must contain exactly one synonym equal to `value`. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms # Required. The primary value associated with this entity entry. # For example, if the entity type is *vegetable*, the value could be # *scallions*. # For `KIND_MAP` entity types: # * A reference value to be used in place of synonyms. # For `KIND_LIST` entity types: # * A string that can contain references to other entity types (with or # without aliases). # Corresponds to the JSON property `value` # @return [String] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @synonyms = args[:synonyms] if args.key?(:synonyms) @value = args[:value] if args.key?(:value) end end # Events allow for matching intents by event name instead of the natural # language input. For instance, input `` can trigger a personalized welcome response. # The parameter `name` may be used by the agent in the response: # `"Hello #welcome_event.name! What can I do for you today?"`. class GoogleCloudDialogflowV2beta1EventInput include Google::Apis::Core::Hashable # Required. The language of this query. See [Language # Support](https://cloud.google.com/dialogflow/docs/reference/language) # for a list of the currently supported language codes. Note that queries in # the same session do not necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # Required. The unique identifier of the event. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The collection of parameters associated with the event. # Depending on your protocol or client library language, this is a # map, associative array, symbol table, dictionary, or JSON object # composed of a collection of (MapKey, MapValue) pairs: # - MapKey type: string # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @language_code = args[:language_code] if args.key?(:language_code) @name = args[:name] if args.key?(:name) @parameters = args[:parameters] if args.key?(:parameters) end end # The response message for Agents.ExportAgent. class GoogleCloudDialogflowV2beta1ExportAgentResponse include Google::Apis::Core::Hashable # Zip compressed raw byte content for agent. # Corresponds to the JSON property `agentContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :agent_content # The URI to a file containing the exported agent. This field is populated # only if `agent_uri` is specified in `ExportAgentRequest`. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @agent_content = args[:agent_content] if args.key?(:agent_content) @agent_uri = args[:agent_uri] if args.key?(:agent_uri) end end # Represents an intent. # Intents convert a number of user expressions or patterns into an action. An # action is an extraction of a user command or sentence semantics. class GoogleCloudDialogflowV2beta1Intent include Google::Apis::Core::Hashable # Optional. The name of the action associated with the intent. # Note: The action name must not contain whitespaces. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Optional. The list of platforms for which the first responses will be # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). # Corresponds to the JSON property `defaultResponsePlatforms` # @return [Array] attr_accessor :default_response_platforms # Required. The name of this intent. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional. Indicates that this intent ends an interaction. Some integrations # (e.g., Actions on Google or Dialogflow phone gateway) use this information # to close interaction with an end user. Default is false. # Corresponds to the JSON property `endInteraction` # @return [Boolean] attr_accessor :end_interaction alias_method :end_interaction?, :end_interaction # Optional. The collection of event names that trigger the intent. # If the collection of input contexts is not empty, all of the contexts must # be present in the active user session for an event to trigger this intent. # Event names are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events # Output only. Information about all followup intents that have this intent as # a direct or indirect parent. We populate this field only in the output. # Corresponds to the JSON property `followupIntentInfo` # @return [Array] attr_accessor :followup_intent_info # Optional. The list of context names required for this intent to be # triggered. # Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `inputContextNames` # @return [Array] attr_accessor :input_context_names # Optional. Indicates whether this is a fallback intent. # Corresponds to the JSON property `isFallback` # @return [Boolean] attr_accessor :is_fallback alias_method :is_fallback?, :is_fallback # Optional. The collection of rich messages corresponding to the # `Response` field in the Dialogflow console. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages # Optional. Indicates whether Machine Learning is disabled for the intent. # Note: If `ml_disabled` setting is set to true, then this intent is not # taken into account during inference in `ML ONLY` match mode. Also, # auto-markup in the UI is turned off. # Corresponds to the JSON property `mlDisabled` # @return [Boolean] attr_accessor :ml_disabled alias_method :ml_disabled?, :ml_disabled # Optional. Indicates whether Machine Learning is enabled for the intent. # Note: If `ml_enabled` setting is set to false, then this intent is not # taken into account during inference in `ML ONLY` match mode. Also, # auto-markup in the UI is turned off. # DEPRECATED! Please use `ml_disabled` field instead. # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, # then the default value is determined as follows: # - Before April 15th, 2018 the default is: # ml_enabled = false / ml_disabled = true. # - After April 15th, 2018 the default is: # ml_enabled = true / ml_disabled = false. # Corresponds to the JSON property `mlEnabled` # @return [Boolean] attr_accessor :ml_enabled alias_method :ml_enabled?, :ml_enabled # Optional. The unique identifier of this intent. # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents # methods. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The collection of contexts that are activated when the intent # is matched. Context messages in this collection should not set the # parameters field. Setting the `lifespan_count` to 0 will reset the context # when the intent is matched. # Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. The collection of parameters associated with the intent. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Optional. The unique identifier of the parent intent in the # chain of followup intents. You can set this field when creating an intent, # for example with CreateIntent or # BatchUpdateIntents, in order to make this # intent a followup intent. # It identifies the parent followup intent. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name # Optional. The priority of this intent. Higher numbers represent higher # priorities. # - If the supplied value is unspecified or 0, the service # translates the value to 500,000, which corresponds to the # `Normal` priority in the console. # - If the supplied value is negative, the intent is ignored # in runtime detect intent requests. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority # Optional. Indicates whether to delete all contexts in the current # session when this intent is matched. # Corresponds to the JSON property `resetContexts` # @return [Boolean] attr_accessor :reset_contexts alias_method :reset_contexts?, :reset_contexts # Output only. The unique identifier of the root intent in the chain of # followup intents. It identifies the correct followup intents chain for # this intent. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `rootFollowupIntentName` # @return [String] attr_accessor :root_followup_intent_name # Optional. The collection of examples that the agent is # trained on. # Corresponds to the JSON property `trainingPhrases` # @return [Array] attr_accessor :training_phrases # Optional. Indicates whether webhooks are enabled for the intent. # Corresponds to the JSON property `webhookState` # @return [String] attr_accessor :webhook_state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms) @display_name = args[:display_name] if args.key?(:display_name) @end_interaction = args[:end_interaction] if args.key?(:end_interaction) @events = args[:events] if args.key?(:events) @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info) @input_context_names = args[:input_context_names] if args.key?(:input_context_names) @is_fallback = args[:is_fallback] if args.key?(:is_fallback) @messages = args[:messages] if args.key?(:messages) @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled) @ml_enabled = args[:ml_enabled] if args.key?(:ml_enabled) @name = args[:name] if args.key?(:name) @output_contexts = args[:output_contexts] if args.key?(:output_contexts) @parameters = args[:parameters] if args.key?(:parameters) @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) @priority = args[:priority] if args.key?(:priority) @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts) @root_followup_intent_name = args[:root_followup_intent_name] if args.key?(:root_followup_intent_name) @training_phrases = args[:training_phrases] if args.key?(:training_phrases) @webhook_state = args[:webhook_state] if args.key?(:webhook_state) end end # Represents a single followup intent in the chain. class GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo include Google::Apis::Core::Hashable # The unique identifier of the followup intent. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `followupIntentName` # @return [String] attr_accessor :followup_intent_name # The unique identifier of the followup intent's parent. # Format: `projects//agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @followup_intent_name = args[:followup_intent_name] if args.key?(:followup_intent_name) @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) end end # Corresponds to the `Response` field in the Dialogflow console. class GoogleCloudDialogflowV2beta1IntentMessage include Google::Apis::Core::Hashable # The basic card message. Useful for displaying information. # Corresponds to the JSON property `basicCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageBasicCard] attr_accessor :basic_card # Browse Carousel Card for Actions on Google. # https://developers.google.com/actions/assistant/responses#browsing_carousel # Corresponds to the JSON property `browseCarouselCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard] attr_accessor :browse_carousel_card # The card response message. # Corresponds to the JSON property `card` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageCard] attr_accessor :card # The card for presenting a carousel of options to select from. # Corresponds to the JSON property `carouselSelect` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect] attr_accessor :carousel_select # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion] attr_accessor :link_out_suggestion # The card for presenting a list of options to select from. # Corresponds to the JSON property `listSelect` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageListSelect] attr_accessor :list_select # The media content card for Actions on Google. # Corresponds to the JSON property `mediaContent` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageMediaContent] attr_accessor :media_content # A custom platform-specific response. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Optional. The platform that this message is intended for. # Corresponds to the JSON property `platform` # @return [String] attr_accessor :platform # The quick replies response message. # Corresponds to the JSON property `quickReplies` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageQuickReplies] attr_accessor :quick_replies # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard] attr_accessor :rbm_carousel_rich_card # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard] attr_accessor :rbm_standalone_rich_card # Rich Business Messaging (RBM) text response with suggestions. # Corresponds to the JSON property `rbmText` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmText] attr_accessor :rbm_text # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses] attr_accessor :simple_responses # The collection of suggestions. # Corresponds to the JSON property `suggestions` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageSuggestions] attr_accessor :suggestions # Table card for Actions on Google. # Corresponds to the JSON property `tableCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageTableCard] attr_accessor :table_card # Plays audio from a file in Telephony Gateway. # Corresponds to the JSON property `telephonyPlayAudio` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio] attr_accessor :telephony_play_audio # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech] attr_accessor :telephony_synthesize_speech # Transfers the call in Telephony Gateway. # Corresponds to the JSON property `telephonyTransferCall` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall] attr_accessor :telephony_transfer_call # The text response message. # Corresponds to the JSON property `text` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageText] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object 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 end # The basic card message. Useful for displaying information. class GoogleCloudDialogflowV2beta1IntentMessageBasicCard include Google::Apis::Core::Hashable # Optional. The collection of card buttons. # Corresponds to the JSON property `buttons` # @return [Array] attr_accessor :buttons # Required, unless image is present. The body text of the card. # Corresponds to the JSON property `formattedText` # @return [String] attr_accessor :formatted_text # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image # Optional. The subtitle of the card. # Corresponds to the JSON property `subtitle` # @return [String] attr_accessor :subtitle # Optional. The title of the card. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @buttons = args[:buttons] if args.key?(:buttons) @formatted_text = args[:formatted_text] if args.key?(:formatted_text) @image = args[:image] if args.key?(:image) @subtitle = args[:subtitle] if args.key?(:subtitle) @title = args[:title] if args.key?(:title) end end # The button object that appears at the bottom of a card. class GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton include Google::Apis::Core::Hashable # Opens the given URI. # Corresponds to the JSON property `openUriAction` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction] attr_accessor :open_uri_action # Required. The title of the button. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @open_uri_action = args[:open_uri_action] if args.key?(:open_uri_action) @title = args[:title] if args.key?(:title) end end # Opens the given URI. class GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction include Google::Apis::Core::Hashable # Required. The HTTP or HTTPS scheme URI. # 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) @uri = args[:uri] if args.key?(:uri) end end # Browse Carousel Card for Actions on Google. # https://developers.google.com/actions/assistant/responses#browsing_carousel class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard include Google::Apis::Core::Hashable # Optional. Settings for displaying the image. Applies to every image in # items. # Corresponds to the JSON property `imageDisplayOptions` # @return [String] attr_accessor :image_display_options # Required. List of items in the Browse Carousel Card. Minimum of two # items, maximum of ten. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @image_display_options = args[:image_display_options] if args.key?(:image_display_options) @items = args[:items] if args.key?(:items) end end # Browsing carousel tile class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem include Google::Apis::Core::Hashable # Optional. Description of the carousel item. Maximum of four lines of # text. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. Text that appears at the bottom of the Browse Carousel # Card. Maximum of one line of text. # Corresponds to the JSON property `footer` # @return [String] attr_accessor :footer # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image # Actions on Google action to open a given url. # Corresponds to the JSON property `openUriAction` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction] attr_accessor :open_uri_action # Required. Title of the carousel item. Maximum of two lines of text. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @footer = args[:footer] if args.key?(:footer) @image = args[:image] if args.key?(:image) @open_uri_action = args[:open_uri_action] if args.key?(:open_uri_action) @title = args[:title] if args.key?(:title) end end # Actions on Google action to open a given url. class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction include Google::Apis::Core::Hashable # Required. URL # Corresponds to the JSON property `url` # @return [String] attr_accessor :url # Optional. Specifies the type of viewer that is used when opening # the URL. Defaults to opening via web browser. # Corresponds to the JSON property `urlTypeHint` # @return [String] attr_accessor :url_type_hint def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @url = args[:url] if args.key?(:url) @url_type_hint = args[:url_type_hint] if args.key?(:url_type_hint) end end # The card response message. class GoogleCloudDialogflowV2beta1IntentMessageCard include Google::Apis::Core::Hashable # Optional. The collection of card buttons. # Corresponds to the JSON property `buttons` # @return [Array] attr_accessor :buttons # Optional. The public URI to an image file for the card. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri # Optional. The subtitle of the card. # Corresponds to the JSON property `subtitle` # @return [String] attr_accessor :subtitle # Optional. The title of the card. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @buttons = args[:buttons] if args.key?(:buttons) @image_uri = args[:image_uri] if args.key?(:image_uri) @subtitle = args[:subtitle] if args.key?(:subtitle) @title = args[:title] if args.key?(:title) end end # Optional. Contains information about a button. class GoogleCloudDialogflowV2beta1IntentMessageCardButton include Google::Apis::Core::Hashable # Optional. The text to send back to the Dialogflow API or a URI to # open. # Corresponds to the JSON property `postback` # @return [String] attr_accessor :postback # Optional. The text to show on the button. # 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) @postback = args[:postback] if args.key?(:postback) @text = args[:text] if args.key?(:text) end end # The card for presenting a carousel of options to select from. class GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect include Google::Apis::Core::Hashable # Required. Carousel items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) end end # An item in the carousel. class GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem include Google::Apis::Core::Hashable # Optional. The body text of the card. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image # Additional info about the select item for when it is triggered in a # dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo] attr_accessor :info # Required. Title of the carousel item. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @image = args[:image] if args.key?(:image) @info = args[:info] if args.key?(:info) @title = args[:title] if args.key?(:title) end end # Column properties for TableCard. class GoogleCloudDialogflowV2beta1IntentMessageColumnProperties include Google::Apis::Core::Hashable # Required. Column heading. # Corresponds to the JSON property `header` # @return [String] attr_accessor :header # Optional. Defines text alignment for all cells in this column. # Corresponds to the JSON property `horizontalAlignment` # @return [String] attr_accessor :horizontal_alignment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @header = args[:header] if args.key?(:header) @horizontal_alignment = args[:horizontal_alignment] if args.key?(:horizontal_alignment) end end # The image response message. class GoogleCloudDialogflowV2beta1IntentMessageImage include Google::Apis::Core::Hashable # A text description of the image to be used for accessibility, # e.g., screen readers. Required if image_uri is set for CarouselSelect. # Corresponds to the JSON property `accessibilityText` # @return [String] attr_accessor :accessibility_text # Optional. The public URI to an image file. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @accessibility_text = args[:accessibility_text] if args.key?(:accessibility_text) @image_uri = args[:image_uri] if args.key?(:image_uri) end end # The suggestion chip message that allows the user to jump out to the app # or website associated with this agent. class GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion include Google::Apis::Core::Hashable # Required. The name of the app or site this chip is linking to. # Corresponds to the JSON property `destinationName` # @return [String] attr_accessor :destination_name # Required. The URI of the app or site to open when the user taps the # suggestion chip. # 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) @destination_name = args[:destination_name] if args.key?(:destination_name) @uri = args[:uri] if args.key?(:uri) end end # The card for presenting a list of options to select from. class GoogleCloudDialogflowV2beta1IntentMessageListSelect include Google::Apis::Core::Hashable # Required. List items. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items # Optional. Subtitle of the list. # Corresponds to the JSON property `subtitle` # @return [String] attr_accessor :subtitle # Optional. The overall title of the list. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @items = args[:items] if args.key?(:items) @subtitle = args[:subtitle] if args.key?(:subtitle) @title = args[:title] if args.key?(:title) end end # An item in the list. class GoogleCloudDialogflowV2beta1IntentMessageListSelectItem include Google::Apis::Core::Hashable # Optional. The main text describing the item. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image # Additional info about the select item for when it is triggered in a # dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo] attr_accessor :info # Required. The title of the list item. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @image = args[:image] if args.key?(:image) @info = args[:info] if args.key?(:info) @title = args[:title] if args.key?(:title) end end # The media content card for Actions on Google. class GoogleCloudDialogflowV2beta1IntentMessageMediaContent include Google::Apis::Core::Hashable # Required. List of media objects. # Corresponds to the JSON property `mediaObjects` # @return [Array] attr_accessor :media_objects # Optional. What type of media is the content (ie "audio"). # Corresponds to the JSON property `mediaType` # @return [String] attr_accessor :media_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @media_objects = args[:media_objects] if args.key?(:media_objects) @media_type = args[:media_type] if args.key?(:media_type) end end # Response media object for media content card. class GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject include Google::Apis::Core::Hashable # Required. Url where the media is stored. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url # Optional. Description of media card. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The image response message. # Corresponds to the JSON property `icon` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :icon # The image response message. # Corresponds to the JSON property `largeImage` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :large_image # Required. Name of media card. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content_url = args[:content_url] if args.key?(:content_url) @description = args[:description] if args.key?(:description) @icon = args[:icon] if args.key?(:icon) @large_image = args[:large_image] if args.key?(:large_image) @name = args[:name] if args.key?(:name) end end # The quick replies response message. class GoogleCloudDialogflowV2beta1IntentMessageQuickReplies include Google::Apis::Core::Hashable # Optional. The collection of quick replies. # Corresponds to the JSON property `quickReplies` # @return [Array] attr_accessor :quick_replies # Optional. The title of the collection of quick replies. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @quick_replies = args[:quick_replies] if args.key?(:quick_replies) @title = args[:title] if args.key?(:title) end end # Rich Business Messaging (RBM) Card content class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent include Google::Apis::Core::Hashable # Optional. Description of the card (at most 2000 bytes). # At least one of the title, description or media must be set. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Rich Business Messaging (RBM) Media displayed in Cards # The following media-types are currently supported: # Image Types # * image/jpeg # * image/jpg' # * image/gif # * image/png # Video Types # * video/h263 # * video/m4v # * video/mp4 # * video/mpeg # * video/mpeg4 # * video/webm # Corresponds to the JSON property `media` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia] attr_accessor :media # Optional. List of suggestions to include in the card. # Corresponds to the JSON property `suggestions` # @return [Array] attr_accessor :suggestions # Optional. Title of the card (at most 200 bytes). # At least one of the title, description or media must be set. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @media = args[:media] if args.key?(:media) @suggestions = args[:suggestions] if args.key?(:suggestions) @title = args[:title] if args.key?(:title) end end # Rich Business Messaging (RBM) Media displayed in Cards # The following media-types are currently supported: # Image Types # * image/jpeg # * image/jpg' # * image/gif # * image/png # Video Types # * video/h263 # * video/m4v # * video/mp4 # * video/mpeg # * video/mpeg4 # * video/webm class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia include Google::Apis::Core::Hashable # Required. Publicly reachable URI of the file. The RBM platform # determines the MIME type of the file from the content-type field in # the HTTP headers when the platform fetches the file. The content-type # field must be present and accurate in the HTTP response from the URL. # Corresponds to the JSON property `fileUri` # @return [String] attr_accessor :file_uri # Required for cards with vertical orientation. The height of the media # 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` # @return [String] attr_accessor :height # Optional. Publicly reachable URI of the thumbnail.If you don't # provide a thumbnail URI, the RBM platform displays a blank # placeholder thumbnail until the user's device downloads the file. # Depending on the user's setting, the file may not download # automatically and may require the user to tap a download button. # Corresponds to the JSON property `thumbnailUri` # @return [String] attr_accessor :thumbnail_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_uri = args[:file_uri] if args.key?(:file_uri) @height = args[:height] if args.key?(:height) @thumbnail_uri = args[:thumbnail_uri] if args.key?(:thumbnail_uri) end 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. # If you want to show a single card with more control over the layout, # please use RbmStandaloneCard instead. class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard include Google::Apis::Core::Hashable # Required. The cards in the carousel. A carousel must have at least # 2 cards and at most 10. # Corresponds to the JSON property `cardContents` # @return [Array] attr_accessor :card_contents # Required. The width of the cards in the carousel. # Corresponds to the JSON property `cardWidth` # @return [String] attr_accessor :card_width def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @card_contents = args[:card_contents] if args.key?(:card_contents) @card_width = args[:card_width] if args.key?(:card_width) end end # 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. class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard include Google::Apis::Core::Hashable # Rich Business Messaging (RBM) Card content # Corresponds to the JSON property `cardContent` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent] attr_accessor :card_content # Required. Orientation of the card. # Corresponds to the JSON property `cardOrientation` # @return [String] attr_accessor :card_orientation # Required if orientation is horizontal. # Image preview alignment for standalone cards with horizontal layout. # Corresponds to the JSON property `thumbnailImageAlignment` # @return [String] attr_accessor :thumbnail_image_alignment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @card_content = args[:card_content] if args.key?(:card_content) @card_orientation = args[:card_orientation] if args.key?(:card_orientation) @thumbnail_image_alignment = args[:thumbnail_image_alignment] if args.key?(:thumbnail_image_alignment) end end # Rich Business Messaging (RBM) suggested client-side action that the user # can choose from the card. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction include Google::Apis::Core::Hashable # Opens the user's default dialer app with the specified phone number # 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 # 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` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri] attr_accessor :open_url # Opaque payload that the Dialogflow receives in a user event # when the user taps the suggested action. This data will be also # forwarded to webhook to allow performing custom business logic. # Corresponds to the JSON property `postbackData` # @return [String] attr_accessor :postback_data # Opens the device's location chooser so the user can pick a location # to send back to the agent. # Corresponds to the JSON property `shareLocation` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation] attr_accessor :share_location # Text to display alongside the action. # 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) @dial = args[:dial] if args.key?(:dial) @open_url = args[:open_url] if args.key?(:open_url) @postback_data = args[:postback_data] if args.key?(:postback_data) @share_location = args[:share_location] if args.key?(:share_location) @text = args[:text] if args.key?(:text) end end # Opens the user's default dialer app with the specified phone number # but does not dial automatically. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial include Google::Apis::Core::Hashable # Required. The phone number to fill in the default dialer app. # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) # format. An example of a correctly formatted phone number: # +15556767888. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @phone_number = args[:phone_number] if args.key?(:phone_number) end end # Opens the user's default web browser app to the specified uri # 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 include Google::Apis::Core::Hashable # Required. The uri to open on the user device # 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) @uri = args[:uri] if args.key?(:uri) end end # Opens the device's location chooser so the user can pick a location # to send back to the agent. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Rich Business Messaging (RBM) suggested reply that the user can click # instead of typing in their own response. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply include Google::Apis::Core::Hashable # Opaque payload that the Dialogflow receives in a user event # when the user taps the suggested reply. This data will be also # forwarded to webhook to allow performing custom business logic. # Corresponds to the JSON property `postbackData` # @return [String] attr_accessor :postback_data # Suggested reply text. # 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) @postback_data = args[:postback_data] if args.key?(:postback_data) @text = args[:text] if args.key?(:text) end end # Rich Business Messaging (RBM) suggestion. Suggestions allow user to # easily select/click a predefined response or perform an action (like # opening a web uri). class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion include Google::Apis::Core::Hashable # Rich Business Messaging (RBM) suggested client-side action that the user # can choose from the card. # Corresponds to the JSON property `action` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction] attr_accessor :action # Rich Business Messaging (RBM) suggested reply that the user can click # instead of typing in their own response. # Corresponds to the JSON property `reply` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply] attr_accessor :reply def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @reply = args[:reply] if args.key?(:reply) end end # Rich Business Messaging (RBM) text response with suggestions. class GoogleCloudDialogflowV2beta1IntentMessageRbmText include Google::Apis::Core::Hashable # Optional. One or more suggestions to show to the user. # Corresponds to the JSON property `rbmSuggestion` # @return [Array] attr_accessor :rbm_suggestion # Required. Text sent and displayed to the user. # 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) @rbm_suggestion = args[:rbm_suggestion] if args.key?(:rbm_suggestion) @text = args[:text] if args.key?(:text) end end # Additional info about the select item for when it is triggered in a # dialog. class GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo include Google::Apis::Core::Hashable # Required. A unique key that will be sent back to the agent if this # response is given. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # Optional. A list of synonyms that can also be used to trigger this # item in dialog. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key = args[:key] if args.key?(:key) @synonyms = args[:synonyms] if args.key?(:synonyms) end end # The simple response message containing speech or text. class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse include Google::Apis::Core::Hashable # Optional. The text to display. # Corresponds to the JSON property `displayText` # @return [String] attr_accessor :display_text # One of text_to_speech or ssml must be provided. Structured spoken # response to the user in the SSML format. Mutually exclusive with # text_to_speech. # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml # One of text_to_speech or ssml must be provided. The plain text of the # speech output. Mutually exclusive with ssml. # Corresponds to the JSON property `textToSpeech` # @return [String] attr_accessor :text_to_speech def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @display_text = args[:display_text] if args.key?(:display_text) @ssml = args[:ssml] if args.key?(:ssml) @text_to_speech = args[:text_to_speech] if args.key?(:text_to_speech) end end # The collection of simple response candidates. # This message in `QueryResult.fulfillment_messages` and # `WebhookResponse.fulfillment_messages` should contain only one # `SimpleResponse`. class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses include Google::Apis::Core::Hashable # Required. The list of simple responses. # Corresponds to the JSON property `simpleResponses` # @return [Array] attr_accessor :simple_responses def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @simple_responses = args[:simple_responses] if args.key?(:simple_responses) end end # The suggestion chip message that the user can tap to quickly post a reply # to the conversation. class GoogleCloudDialogflowV2beta1IntentMessageSuggestion include Google::Apis::Core::Hashable # Required. The text shown the in the suggestion chip. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @title = args[:title] if args.key?(:title) end end # The collection of suggestions. class GoogleCloudDialogflowV2beta1IntentMessageSuggestions include Google::Apis::Core::Hashable # Required. The list of suggested replies. # Corresponds to the JSON property `suggestions` # @return [Array] attr_accessor :suggestions def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @suggestions = args[:suggestions] if args.key?(:suggestions) end end # Table card for Actions on Google. class GoogleCloudDialogflowV2beta1IntentMessageTableCard include Google::Apis::Core::Hashable # Optional. List of buttons for the card. # Corresponds to the JSON property `buttons` # @return [Array] attr_accessor :buttons # Optional. Display properties for the columns in this table. # Corresponds to the JSON property `columnProperties` # @return [Array] attr_accessor :column_properties # The image response message. # Corresponds to the JSON property `image` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image # Optional. Rows in this table of data. # Corresponds to the JSON property `rows` # @return [Array] attr_accessor :rows # Optional. Subtitle to the title. # Corresponds to the JSON property `subtitle` # @return [String] attr_accessor :subtitle # Required. Title of the card. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @buttons = args[:buttons] if args.key?(:buttons) @column_properties = args[:column_properties] if args.key?(:column_properties) @image = args[:image] if args.key?(:image) @rows = args[:rows] if args.key?(:rows) @subtitle = args[:subtitle] if args.key?(:subtitle) @title = args[:title] if args.key?(:title) end end # Cell of TableCardRow. class GoogleCloudDialogflowV2beta1IntentMessageTableCardCell include Google::Apis::Core::Hashable # Required. Text in this cell. # 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) @text = args[:text] if args.key?(:text) end end # Row of TableCard. class GoogleCloudDialogflowV2beta1IntentMessageTableCardRow include Google::Apis::Core::Hashable # Optional. List of cells that make up this row. # Corresponds to the JSON property `cells` # @return [Array] attr_accessor :cells # Optional. Whether to add a visual divider after this row. # Corresponds to the JSON property `dividerAfter` # @return [Boolean] attr_accessor :divider_after alias_method :divider_after?, :divider_after def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cells = args[:cells] if args.key?(:cells) @divider_after = args[:divider_after] if args.key?(:divider_after) end end # Plays audio from a file in Telephony Gateway. class GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio include Google::Apis::Core::Hashable # Required. URI to a Google Cloud Storage object containing the audio to # play, e.g., "gs://bucket/object". The object must contain a single # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. # This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account # where is the number of the Telephony Gateway project # (usually the same as the Dialogflow agent project). If the Google Cloud # Storage bucket is in the Telephony Gateway project, this permission is # added by default when enabling the Dialogflow V2 API. # For audio from other sources, consider using the # `TelephonySynthesizeSpeech` message with SSML. # 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) @audio_uri = args[:audio_uri] if args.key?(:audio_uri) end end # 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. class GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech include Google::Apis::Core::Hashable # The SSML to be synthesized. For more information, see # [SSML](https://developers.google.com/actions/reference/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 # Transfers the call in Telephony Gateway. class GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall include Google::Apis::Core::Hashable # Required. The phone number to transfer the call to # in [E.164 format](https://en.wikipedia.org/wiki/E.164). # We currently only allow transferring to US numbers (+1xxxyyyzzzz). # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @phone_number = args[:phone_number] if args.key?(:phone_number) end end # The text response message. class GoogleCloudDialogflowV2beta1IntentMessageText include Google::Apis::Core::Hashable # Optional. The collection of the agent's responses. # Corresponds to the JSON property `text` # @return [Array] attr_accessor :text def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @text = args[:text] if args.key?(:text) end end # Represents intent parameters. class GoogleCloudDialogflowV2beta1IntentParameter include Google::Apis::Core::Hashable # Optional. The default value to use when the `value` yields an empty # result. # Default values can be extracted from contexts by using the following # syntax: `#context_name.parameter_name`. # Corresponds to the JSON property `defaultValue` # @return [String] attr_accessor :default_value # Required. The name of the parameter. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Optional. The name of the entity type, prefixed with `@`, that # describes values of the parameter. If the parameter is # required, this must be provided. # Corresponds to the JSON property `entityTypeDisplayName` # @return [String] attr_accessor :entity_type_display_name # Optional. Indicates whether the parameter represents a list of values. # Corresponds to the JSON property `isList` # @return [Boolean] attr_accessor :is_list alias_method :is_list?, :is_list # Optional. Indicates whether the parameter is required. That is, # whether the intent cannot be completed without collecting the parameter # value. # Corresponds to the JSON property `mandatory` # @return [Boolean] attr_accessor :mandatory alias_method :mandatory?, :mandatory # The unique identifier of this parameter. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The collection of prompts that the agent can present to the # user in order to collect a value for the parameter. # Corresponds to the JSON property `prompts` # @return [Array] attr_accessor :prompts # Optional. The definition of the parameter value. It can be: # - a constant string, # - a parameter value defined as `$parameter_name`, # - an original parameter value defined as `$parameter_name.original`, # - a parameter value from some context defined as # `#context_name.parameter_name`. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_value = args[:default_value] if args.key?(:default_value) @display_name = args[:display_name] if args.key?(:display_name) @entity_type_display_name = args[:entity_type_display_name] if args.key?(:entity_type_display_name) @is_list = args[:is_list] if args.key?(:is_list) @mandatory = args[:mandatory] if args.key?(:mandatory) @name = args[:name] if args.key?(:name) @prompts = args[:prompts] if args.key?(:prompts) @value = args[:value] if args.key?(:value) end end # Represents an example that the agent is trained on. class GoogleCloudDialogflowV2beta1IntentTrainingPhrase include Google::Apis::Core::Hashable # Output only. The unique identifier of this training phrase. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The ordered list of training phrase parts. # The parts are concatenated in order to form the training phrase. # Note: The API does not automatically annotate training phrases like the # Dialogflow Console does. # Note: Do not forget to include whitespace at part boundaries, # so the training phrase is well formatted when the parts are concatenated. # If the training phrase does not need to be annotated with parameters, # you just need a single part with only the Part.text field set. # If you want to annotate the training phrase, you must create multiple # parts, where the fields of each part are populated in one of two ways: # - `Part.text` is set to a part of the phrase that has no parameters. # - `Part.text` is set to a part of the phrase that you want to annotate, # and the `entity_type`, `alias`, and `user_defined` fields are all # set. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts # Optional. Indicates how many times this example was added to # the intent. Each time a developer adds an existing sample by editing an # intent or training, this counter is increased. # Corresponds to the JSON property `timesAddedCount` # @return [Fixnum] attr_accessor :times_added_count # Required. The type of the training phrase. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @parts = args[:parts] if args.key?(:parts) @times_added_count = args[:times_added_count] if args.key?(:times_added_count) @type = args[:type] if args.key?(:type) end end # Represents a part of a training phrase. class GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart include Google::Apis::Core::Hashable # Optional. The parameter name for the value extracted from the # annotated part of the example. # This field is required for annotated parts of the training phrase. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias # Optional. The entity type name prefixed with `@`. # This field is required for annotated parts of the training phrase. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type # Required. The text for this part. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text # Optional. Indicates whether the text was manually annotated. # This field is set to true when the Dialogflow Console is used to # manually annotate the part. When creating an annotated part with the # API, you must set this to true. # Corresponds to the JSON property `userDefined` # @return [Boolean] attr_accessor :user_defined alias_method :user_defined?, :user_defined def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alias = args[:alias] if args.key?(:alias) @entity_type = args[:entity_type] if args.key?(:entity_type) @text = args[:text] if args.key?(:text) @user_defined = args[:user_defined] if args.key?(:user_defined) end end # Represents the result of querying a Knowledge base. class GoogleCloudDialogflowV2beta1KnowledgeAnswers include Google::Apis::Core::Hashable # A list of answers from Knowledge Connector. # Corresponds to the JSON property `answers` # @return [Array] attr_accessor :answers def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @answers = args[:answers] if args.key?(:answers) end end # An answer from Knowledge Connector. class GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer include Google::Apis::Core::Hashable # The piece of text from the `source` knowledge base document that answers # this conversational query. # Corresponds to the JSON property `answer` # @return [String] attr_accessor :answer # The corresponding FAQ question if the answer was extracted from a FAQ # Document, empty otherwise. # Corresponds to the JSON property `faqQuestion` # @return [String] attr_accessor :faq_question # The system's confidence score that this Knowledge answer is a good match # for this conversational query. # The range is from 0.0 (completely uncertain) to 1.0 (completely certain). # Note: The confidence score is likely to vary somewhat (possibly even for # identical requests), as the underlying model is under constant # improvement. It may be deprecated in the future. We recommend using # `match_confidence_level` which should be generally more stable. # Corresponds to the JSON property `matchConfidence` # @return [Float] attr_accessor :match_confidence # The system's confidence level that this knowledge answer is a good match # for this conversational query. # NOTE: The confidence level for a given `` pair may change # without notice, as it depends on models that are constantly being # improved. However, it will change less frequently than the confidence # score below, and should be preferred for referencing the quality of an # answer. # Corresponds to the JSON property `matchConfidenceLevel` # @return [String] attr_accessor :match_confidence_level # Indicates which Knowledge Document this answer was extracted from. # Format: `projects//knowledgeBases//documents/`. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @answer = args[:answer] if args.key?(:answer) @faq_question = args[:faq_question] if args.key?(:faq_question) @match_confidence = args[:match_confidence] if args.key?(:match_confidence) @match_confidence_level = args[:match_confidence_level] if args.key?(:match_confidence_level) @source = args[:source] if args.key?(:source) end end # Metadata in google::longrunning::Operation for Knowledge operations. class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata include Google::Apis::Core::Hashable # Required. Output only. The current state of this operation. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @state = args[:state] if args.key?(:state) end end # The response for # ConversationDatasets.LabelConversation. class GoogleCloudDialogflowV2beta1LabelConversationResponse include Google::Apis::Core::Hashable # Represents an annotated conversation dataset. # ConversationDataset can have multiple AnnotatedConversationDataset, each of # them represents one result from one annotation task. # AnnotatedConversationDataset can only be generated from annotation task, # which will be triggered by LabelConversation. # Corresponds to the JSON property `annotatedConversationDataset` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1AnnotatedConversationDataset] attr_accessor :annotated_conversation_dataset def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @annotated_conversation_dataset = args[:annotated_conversation_dataset] if args.key?(:annotated_conversation_dataset) end end # Represents the contents of the original request that was passed to # the `[Streaming]DetectIntent` call. class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest include Google::Apis::Core::Hashable # Optional. This field is set to the value of the `QueryParameters.payload` # field passed in the request. Some integrations that query a Dialogflow # agent may provide additional information in the payload. # In particular, for the Dialogflow Phone Gateway integration, this field has # the form: #
`
        # "telephony": `
        # "caller_id": "+18558363987"
        # `
        # `
# Note: The caller ID field (`caller_id`) will be redacted for Standard # Edition agents and populated with the caller ID in [E.164 # format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # The source of this request, e.g., `google`, `facebook`, `slack`. It is set # by Dialogflow-owned servers. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source # Optional. The version of the protocol used for this request. # This field is AoG-specific. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @payload = args[:payload] if args.key?(:payload) @source = args[:source] if args.key?(:source) @version = args[:version] if args.key?(:version) end end # Represents the result of conversational query or event processing. class GoogleCloudDialogflowV2beta1QueryResult include Google::Apis::Core::Hashable # The action name from the matched intent. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # This field is set to: # - `false` if the matched intent has required parameters and not all of # the required parameter values have been collected. # - `true` if all required parameter values have been collected, or if the # matched intent doesn't contain any required parameters. # Corresponds to the JSON property `allRequiredParamsPresent` # @return [Boolean] attr_accessor :all_required_params_present alias_method :all_required_params_present?, :all_required_params_present # Free-form diagnostic information for the associated detect intent request. # The fields of this data can change without notice, so you should not write # code that depends on its structure. # The data may contain: # - webhook call latency # - webhook errors # Corresponds to the JSON property `diagnosticInfo` # @return [Hash] attr_accessor :diagnostic_info # The collection of rich messages to present to the user. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages # The text to be pronounced to the user or shown on the screen. # Note: This is a legacy field, `fulfillment_messages` should be preferred. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text # Represents an intent. # Intents convert a number of user expressions or patterns into an action. An # action is an extraction of a user command or sentence semantics. # Corresponds to the JSON property `intent` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Intent] attr_accessor :intent # The intent detection confidence. Values range from 0.0 # (completely uncertain) to 1.0 (completely certain). # This value is for informational purpose only and is only used to # help match the best intent within the classification threshold. # This value may change for the same end-user expression at any time due to a # model retraining or change in implementation. # If there are `multiple knowledge_answers` messages, this value is set to # the greatest `knowledgeAnswers.match_confidence` value in the list. # Corresponds to the JSON property `intentDetectionConfidence` # @return [Float] attr_accessor :intent_detection_confidence # Represents the result of querying a Knowledge base. # Corresponds to the JSON property `knowledgeAnswers` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1KnowledgeAnswers] attr_accessor :knowledge_answers # The language that was triggered during intent detection. # See [Language # Support](https://cloud.google.com/dialogflow/docs/reference/language) # for a list of the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code # The collection of output contexts. If applicable, # `output_contexts.parameters` contains entries with name # `.original` containing the original parameter values # before the query. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # The collection of extracted parameters. # Depending on your protocol or client library language, this is a # map, associative array, symbol table, dictionary, or JSON object # composed of a collection of (MapKey, MapValue) pairs: # - MapKey type: string # - MapKey value: parameter name # - MapValue type: # - If parameter's entity type is a composite entity: map # - Else: string or number, depending on parameter value type # - MapValue value: # - If parameter's entity type is a composite entity: # map from composite entity property names to property values # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters # The original conversational query text: # - If natural language text was provided as input, `query_text` contains # a copy of the input. # - If natural language speech audio was provided as input, `query_text` # contains the speech recognition result. If speech recognizer produced # multiple alternatives, a particular one is picked. # - If automatic spell correction is enabled, `query_text` will contain the # corrected user input. # Corresponds to the JSON property `queryText` # @return [String] attr_accessor :query_text # 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 # The Speech recognition confidence between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are # correct. The default of 0.0 is a sentinel value indicating that confidence # was not set. # This field is not guaranteed to be accurate or set. In particular this # field isn't set for StreamingDetectIntent since the streaming endpoint has # separate confidence estimates per portion of the audio in # StreamingRecognitionResult. # Corresponds to the JSON property `speechRecognitionConfidence` # @return [Float] attr_accessor :speech_recognition_confidence # If the query was fulfilled by a webhook call, this field is set to the # value of the `payload` field returned in the webhook response. # Corresponds to the JSON property `webhookPayload` # @return [Hash] attr_accessor :webhook_payload # If the query was fulfilled by a webhook call, this field is set to the # value of the `source` field returned in the webhook response. # Corresponds to the JSON property `webhookSource` # @return [String] attr_accessor :webhook_source def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @action = args[:action] if args.key?(:action) @all_required_params_present = args[:all_required_params_present] if args.key?(:all_required_params_present) @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info) @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) @intent = args[:intent] if args.key?(:intent) @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence) @knowledge_answers = args[:knowledge_answers] if args.key?(:knowledge_answers) @language_code = args[:language_code] if args.key?(:language_code) @output_contexts = args[:output_contexts] if args.key?(:output_contexts) @parameters = args[:parameters] if args.key?(:parameters) @query_text = args[:query_text] if args.key?(:query_text) @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result) @speech_recognition_confidence = args[:speech_recognition_confidence] if args.key?(:speech_recognition_confidence) @webhook_payload = args[:webhook_payload] if args.key?(:webhook_payload) @webhook_source = args[:webhook_source] if args.key?(:webhook_source) end end # The sentiment, such as positive/negative feeling or association, for a unit # of analysis, such as the query text. class GoogleCloudDialogflowV2beta1Sentiment include Google::Apis::Core::Hashable # A non-negative number in the [0, +inf) range, which represents the absolute # magnitude of sentiment, regardless of score (positive or negative). # Corresponds to the JSON property `magnitude` # @return [Float] attr_accessor :magnitude # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive # sentiment). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @magnitude = args[:magnitude] if args.key?(:magnitude) @score = args[:score] if args.key?(:score) end end # 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 # The sentiment, such as positive/negative feeling or association, for a unit # of analysis, such as the query text. # Corresponds to the JSON property `queryTextSentiment` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Sentiment] attr_accessor :query_text_sentiment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @query_text_sentiment = args[:query_text_sentiment] if args.key?(:query_text_sentiment) end end # Represents a session entity type. # Extends or replaces a custom entity type at the user session level (we # refer to the entity types defined at the agent level as "custom entity # types"). # Note: session entity types apply to all queries, regardless of the language. class GoogleCloudDialogflowV2beta1SessionEntityType include Google::Apis::Core::Hashable # Required. The collection of entities associated with this session entity # type. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities # Required. Indicates whether the additional data should override or # supplement the custom entity type definition. # Corresponds to the JSON property `entityOverrideMode` # @return [String] attr_accessor :entity_override_mode # Required. The unique identifier of this session entity type. Format: # `projects//agent/sessions//entityTypes/`, or # `projects//agent/environments//users//sessions//entityTypes/`. # If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # `` must be the display name of an existing entity # type in the same agent that will be overridden or supplemented. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entities = args[:entities] if args.key?(:entities) @entity_override_mode = args[:entity_override_mode] if args.key?(:entity_override_mode) @name = args[:name] if args.key?(:name) end end # The request message for a webhook call. class GoogleCloudDialogflowV2beta1WebhookRequest include Google::Apis::Core::Hashable # Alternative query results from KnowledgeService. # Corresponds to the JSON property `alternativeQueryResults` # @return [Array] attr_accessor :alternative_query_results # Represents the contents of the original request that was passed to # the `[Streaming]DetectIntent` call. # Corresponds to the JSON property `originalDetectIntentRequest` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest] attr_accessor :original_detect_intent_request # Represents the result of conversational query or event processing. # Corresponds to the JSON property `queryResult` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1QueryResult] attr_accessor :query_result # The unique identifier of the response. Contains the same value as # `[Streaming]DetectIntentResponse.response_id`. # Corresponds to the JSON property `responseId` # @return [String] attr_accessor :response_id # The unique identifier of detectIntent request session. # Can be used to identify end-user inside webhook implementation. # Format: `projects//agent/sessions/`, or # `projects//agent/environments//users//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @alternative_query_results = args[:alternative_query_results] if args.key?(:alternative_query_results) @original_detect_intent_request = args[:original_detect_intent_request] if args.key?(:original_detect_intent_request) @query_result = args[:query_result] if args.key?(:query_result) @response_id = args[:response_id] if args.key?(:response_id) @session = args[:session] if args.key?(:session) end end # The response message for a webhook call. # This response is validated by the Dialogflow server. If validation fails, # an error will be returned in the QueryResult.diagnostic_info field. # Setting JSON fields to an empty value with the wrong type is a common error. # To avoid this error: # - Use `""` for empty strings # - Use ```` or `null` for empty objects # - Use `[]` or `null` for empty arrays # For more information, see the # [Protocol Buffers Language # Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). class GoogleCloudDialogflowV2beta1WebhookResponse include Google::Apis::Core::Hashable # Optional. Indicates that this intent ends an interaction. Some integrations # (e.g., Actions on Google or Dialogflow phone gateway) use this information # to close interaction with an end user. Default is false. # Corresponds to the JSON property `endInteraction` # @return [Boolean] attr_accessor :end_interaction alias_method :end_interaction?, :end_interaction # Events allow for matching intents by event name instead of the natural # language input. For instance, input `` can trigger a personalized welcome response. # The parameter `name` may be used by the agent in the response: # `"Hello #welcome_event.name! What can I do for you today?"`. # Corresponds to the JSON property `followupEventInput` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1EventInput] attr_accessor :followup_event_input # Optional. The rich response messages intended for the end-user. # When provided, Dialogflow uses this field to populate # QueryResult.fulfillment_messages sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages # Optional. The text response message intended for the end-user. # It is recommended to use `fulfillment_messages.text.text[0]` instead. # When provided, Dialogflow uses this field to populate # QueryResult.fulfillment_text sent to the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text # Optional. The collection of output contexts that will overwrite currently # active contexts for the session and reset their lifespans. # When provided, Dialogflow uses this field to populate # QueryResult.output_contexts sent to the integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the # integration or API caller. Arbitrary JSON objects are supported. # When provided, Dialogflow uses this field to populate # QueryResult.webhook_payload sent to the integration or API caller. # This field is also used by the # [Google Assistant # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) # for rich response messages. # See the format definition at [Google Assistant Dialogflow webhook # format](https://developers.google.com/assistant/actions/build/json/dialogflow- # webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Optional. Additional session entity types to replace or extend developer # entity types with. The entity synonyms apply to all languages and persist # for the session. Setting this data from a webhook overwrites # the session entity types that have been set using `detectIntent`, # `streamingDetectIntent` or SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types # Optional. A custom field used to identify the webhook source. # Arbitrary strings are supported. # When provided, Dialogflow uses this field to populate # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_interaction = args[:end_interaction] if args.key?(:end_interaction) @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input) @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) @output_contexts = args[:output_contexts] if args.key?(:output_contexts) @payload = args[:payload] if args.key?(:payload) @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) @source = args[:source] if args.key?(:source) end end # The response message for Agents.ExportAgent. class GoogleCloudDialogflowV3alpha1ExportAgentResponse include Google::Apis::Core::Hashable # Uncompressed raw byte content for agent. # Corresponds to the JSON property `agentContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :agent_content # The URI to a file containing the exported agent. This field is populated # only if `agent_uri` is specified in ExportAgentRequest. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @agent_content = args[:agent_content] if args.key?(:agent_content) @agent_uri = args[:agent_uri] if args.key?(:agent_uri) end end # The response message for Operations.ListOperations. class GoogleLongrunningListOperationsResponse include Google::Apis::Core::Hashable # The standard List next-page token. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A list of operations that matches the specified filter in the request. # Corresponds to the JSON property `operations` # @return [Array] attr_accessor :operations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @operations = args[:operations] if args.key?(:operations) end end # This resource represents a long-running operation that is the result of a # network API call. class GoogleLongrunningOperation include Google::Apis::Core::Hashable # If the value is `false`, it means the operation is still in progress. # If `true`, the operation is completed, and either `error` or `response` is # available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done # The `Status` type defines a logical error model that is suitable for # different programming environments, including REST APIs and RPC APIs. It is # used by [gRPC](https://github.com/grpc). Each `Status` message contains # three pieces of data: error code, error message, and error details. # You can find out more about this error model and how to work with it in the # [API Design Guide](https://cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::DialogflowV2::GoogleRpcStatus] attr_accessor :error # Service-specific metadata associated with the operation. It typically # contains progress information and common metadata such as create time. # Some services might not provide such metadata. Any method that returns a # long-running operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The normal response of the operation in case of success. If the original # method returns no data on success, such as `Delete`, the response is # `google.protobuf.Empty`. If the original method is standard # `Get`/`Create`/`Update`, the response should be the resource. For other # methods, the response should have the type `XxxResponse`, where `Xxx` # is the original method name. For example, if the original method name # is `TakeSnapshot()`, the inferred response type is # `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @done = args[:done] if args.key?(:done) @error = args[:error] if args.key?(:error) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @response = args[:response] if args.key?(:response) end end # A generic empty message that you can re-use to avoid defining duplicated # empty messages in your APIs. A typical example is to use it as the request # or the response type of an API method. For instance: # service Foo ` # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); # ` # The JSON representation for `Empty` is empty JSON object ````. class GoogleProtobufEmpty include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The `Status` type defines a logical error model that is suitable for # different programming environments, including REST APIs and RPC APIs. It is # used by [gRPC](https://github.com/grpc). Each `Status` message contains # three pieces of data: error code, error message, and error details. # You can find out more about this error model and how to work with it in the # [API Design Guide](https://cloud.google.com/apis/design/errors). class GoogleRpcStatus include Google::Apis::Core::Hashable # The status code, which should be an enum value of google.rpc.Code. # Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details # A developer-facing error message, which should be in English. Any # user-facing error message should be localized and sent in the # google.rpc.Status.details field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @details = args[:details] if args.key?(:details) @message = args[:message] if args.key?(:message) end end # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. class GoogleTypeLatLng include Google::Apis::Core::Hashable # The latitude in degrees. It must be in the range [-90.0, +90.0]. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude # The longitude in degrees. It must be in the range [-180.0, +180.0]. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @latitude = args[:latitude] if args.key?(:latitude) @longitude = args[:longitude] if args.key?(:longitude) end end end end end