diff --git a/api_names_out.yaml b/api_names_out.yaml index a1a59204511..e45c8e6802b 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -90299,6 +90299,8 @@ "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1QueryParameters/sessionEntityTypes": session_entity_types "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1QueryParameters/sessionEntityTypes/session_entity_type": session_entity_type "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1QueryParameters/timeZone": time_zone +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1QueryParameters/webhookHeaders": webhook_headers +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1QueryParameters/webhookHeaders/webhook_header": webhook_header "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1QueryResult": google_cloud_dialogflow_cx_v3beta1_query_result "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1QueryResult/currentPage": current_page "/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1QueryResult/diagnosticInfo": diagnostic_info diff --git a/generated/google/apis/dialogflow_v3beta1.rb b/generated/google/apis/dialogflow_v3beta1.rb index 2c51a391622..7112d5c0fba 100644 --- a/generated/google/apis/dialogflow_v3beta1.rb +++ b/generated/google/apis/dialogflow_v3beta1.rb @@ -26,7 +26,7 @@ module Apis # @see https://cloud.google.com/dialogflow/ module DialogflowV3beta1 VERSION = 'V3beta1' - REVISION = '20201109' + REVISION = '20201201' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v3beta1/classes.rb b/generated/google/apis/dialogflow_v3beta1/classes.rb index f28dbe8673d..1c54e94dd40 100644 --- a/generated/google/apis/dialogflow_v3beta1/classes.rb +++ b/generated/google/apis/dialogflow_v3beta1/classes.rb @@ -22,651 +22,6 @@ module Google module Apis module DialogflowV3beta1 - # Represents page information communicated to and from the webhook. - class GoogleCloudDialogflowCxV3PageInfo - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfoFormInfo] - 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 GoogleCloudDialogflowCxV3PageInfoFormInfo - 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 GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo - 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 GoogleCloudDialogflowCxV3ResponseMessage - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess] - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageEndInteraction] - attr_accessor :end_interaction - - # 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff] - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudio] - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText] - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio] - attr_accessor :play_audio - - # The text response message. - # Corresponds to the JSON property `text` - # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageText] - 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) - @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 GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess - 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 GoogleCloudDialogflowCxV3ResponseMessageEndInteraction - 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 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 GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff - 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 GoogleCloudDialogflowCxV3ResponseMessageMixedAudio - 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 GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment - include Google::Apis::Core::Hashable - - # Output only. 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 GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText - include Google::Apis::Core::Hashable - - # Output only. 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 - - # 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) - @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption) - @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 GoogleCloudDialogflowCxV3ResponseMessagePlayAudio - include Google::Apis::Core::Hashable - - # Output only. 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 GoogleCloudDialogflowCxV3ResponseMessageText - include Google::Apis::Core::Hashable - - # Output only. 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 GoogleCloudDialogflowCxV3SessionInfo - 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 GoogleCloudDialogflowCxV3WebhookRequest - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo] - attr_accessor :fulfillment_info - - # Represents intent information communicated to the webhook. - # Corresponds to the JSON property `intentInfo` - # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo] - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfo] - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3SessionInfo] - 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 GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo - 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 GoogleCloudDialogflowCxV3WebhookRequestIntentInfo - 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 GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue - 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 GoogleCloudDialogflowCxV3WebhookResponse - include Google::Apis::Core::Hashable - - # Represents a fulfillment response to the user. - # Corresponds to the JSON property `fulfillmentResponse` - # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse] - attr_accessor :fulfillment_response - - # Represents page information communicated to and from the webhook. - # Corresponds to the JSON property `pageInfo` - # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfo] - 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::DialogflowV3beta1::GoogleCloudDialogflowCxV3SessionInfo] - 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 GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse - 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 - # Agents are best described as Natural Language Understanding (NLU) modules that # transform user requests into actionable data. You can include agents in your # app, product, or service to determine user intent and respond to the user in a @@ -2837,6 +2192,18 @@ class GoogleCloudDialogflowCxV3beta1QueryParameters # @return [String] attr_accessor :time_zone + # This field can be used to pass HTTP headers for a webhook call. These headers + # will be sent to webhook along with the headers that have been configured + # through Dialogflow web console. The headers defined within this field will + # overwrite the headers configured through Dialogflow console if there is a + # conflict. Header names are case-insensitive. Google's specified headers are + # not allowed. Including: "Host", "Content-Length", "Connection", "From", "User- + # Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded- + # For", etc. + # Corresponds to the JSON property `webhookHeaders` + # @return [Hash] + attr_accessor :webhook_headers + def initialize(**args) update!(**args) end @@ -2849,6 +2216,7 @@ def update!(**args) @payload = args[:payload] if args.key?(:payload) @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) @time_zone = args[:time_zone] if args.key?(:time_zone) + @webhook_headers = args[:webhook_headers] if args.key?(:webhook_headers) end end @@ -5625,8 +4993,8 @@ class GoogleCloudDialogflowV2Message # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2MessageAnnotation] attr_accessor :message_annotation - # The unique identifier of the message. Format: `projects//conversations// - # messages/`. + # The unique identifier of the message. Format: `projects//locations// + # conversations//messages/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name diff --git a/generated/google/apis/dialogflow_v3beta1/representations.rb b/generated/google/apis/dialogflow_v3beta1/representations.rb index 91da4f07733..f6bc73f3491 100644 --- a/generated/google/apis/dialogflow_v3beta1/representations.rb +++ b/generated/google/apis/dialogflow_v3beta1/representations.rb @@ -22,120 +22,6 @@ module Google module Apis module DialogflowV3beta1 - class GoogleCloudDialogflowCxV3PageInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3PageInfoFormInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3ResponseMessage - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3ResponseMessageEndInteraction - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3ResponseMessageMixedAudio - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3ResponseMessagePlayAudio - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3ResponseMessageText - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3SessionInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3WebhookRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3WebhookRequestIntentInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3WebhookResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudDialogflowCxV3beta1Agent class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1366,191 +1252,6 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudDialogflowCxV3PageInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :current_page, as: 'currentPage' - property :form_info, as: 'formInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfoFormInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfoFormInfo::Representation - - end - end - - class GoogleCloudDialogflowCxV3PageInfoFormInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :parameter_info, as: 'parameterInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo::Representation - - end - end - - class GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :display_name, as: 'displayName' - property :just_collected, as: 'justCollected' - property :required, as: 'required' - property :state, as: 'state' - property :value, as: 'value' - end - end - - class GoogleCloudDialogflowCxV3ResponseMessage - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess::Representation - - property :end_interaction, as: 'endInteraction', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageEndInteraction, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageEndInteraction::Representation - - property :live_agent_handoff, as: 'liveAgentHandoff', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff::Representation - - property :mixed_audio, as: 'mixedAudio', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudio, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudio::Representation - - property :output_audio_text, as: 'outputAudioText', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText::Representation - - hash :payload, as: 'payload' - property :play_audio, as: 'playAudio', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessagePlayAudio::Representation - - property :text, as: 'text', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageText, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageText::Representation - - end - end - - class GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :metadata, as: 'metadata' - end - end - - class GoogleCloudDialogflowCxV3ResponseMessageEndInteraction - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :metadata, as: 'metadata' - end - end - - class GoogleCloudDialogflowCxV3ResponseMessageMixedAudio - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :segments, as: 'segments', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment::Representation - - end - end - - class GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :allow_playback_interruption, as: 'allowPlaybackInterruption' - property :audio, :base64 => true, as: 'audio' - property :uri, as: 'uri' - end - end - - class GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :allow_playback_interruption, as: 'allowPlaybackInterruption' - property :ssml, as: 'ssml' - property :text, as: 'text' - end - end - - class GoogleCloudDialogflowCxV3ResponseMessagePlayAudio - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :allow_playback_interruption, as: 'allowPlaybackInterruption' - property :audio_uri, as: 'audioUri' - end - end - - class GoogleCloudDialogflowCxV3ResponseMessageText - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :allow_playback_interruption, as: 'allowPlaybackInterruption' - collection :text, as: 'text' - end - end - - class GoogleCloudDialogflowCxV3SessionInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :parameters, as: 'parameters' - property :session, as: 'session' - end - end - - class GoogleCloudDialogflowCxV3WebhookRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :detect_intent_response_id, as: 'detectIntentResponseId' - property :fulfillment_info, as: 'fulfillmentInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo::Representation - - property :intent_info, as: 'intentInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfo::Representation - - collection :messages, as: 'messages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessage::Representation - - property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfo::Representation - - hash :payload, as: 'payload' - property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3SessionInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3SessionInfo::Representation - - end - end - - class GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :tag, as: 'tag' - end - end - - class GoogleCloudDialogflowCxV3WebhookRequestIntentInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :last_matched_intent, as: 'lastMatchedIntent' - hash :parameters, as: 'parameters', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue::Representation - - end - end - - class GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :original_value, as: 'originalValue' - property :resolved_value, as: 'resolvedValue' - end - end - - class GoogleCloudDialogflowCxV3WebhookResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :fulfillment_response, as: 'fulfillmentResponse', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse::Representation - - property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfo::Representation - - hash :payload, as: 'payload' - property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3SessionInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3SessionInfo::Representation - - property :target_flow, as: 'targetFlow' - property :target_page, as: 'targetPage' - end - end - - class GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :merge_behavior, as: 'mergeBehavior' - collection :messages, as: 'messages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3ResponseMessage::Representation - - end - end - class GoogleCloudDialogflowCxV3beta1Agent # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2118,6 +1819,7 @@ class Representation < Google::Apis::Core::JsonRepresentation collection :session_entity_types, as: 'sessionEntityTypes', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionEntityType::Representation property :time_zone, as: 'timeZone' + hash :webhook_headers, as: 'webhookHeaders' end end diff --git a/generated/google/apis/dialogflow_v3beta1/service.rb b/generated/google/apis/dialogflow_v3beta1/service.rb index fcce52568aa..7b5c148a6d1 100644 --- a/generated/google/apis/dialogflow_v3beta1/service.rb +++ b/generated/google/apis/dialogflow_v3beta1/service.rb @@ -709,6 +709,8 @@ def patch_project_location_agent_environment(name, google_cloud_dialogflow_cx_v3 # Processes a natural language query and returns structured, actionable data as # a result. This method is not idempotent, because it may cause session entity # types to be updated, which in turn might affect results of future queries. + # Note: Always use agent versions for production traffic. See [Versions and + # environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). # @param [String] session # Required. The name of the session this query is sent to. Format: `projects// # locations//agents//sessions/` or `projects//locations//agents//environments// @@ -717,7 +719,9 @@ def patch_project_location_agent_environment(name, google_cloud_dialogflow_cx_v3 # It can be a random number or some type of session identifiers (preferably # hashed). The length of the `Session ID` must not exceed 36 characters. For # more information, see the [sessions guide](https://cloud.google.com/dialogflow/ - # cx/docs/concept/session). + # cx/docs/concept/session). Note: Always use agent versions for production + # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/ + # cx/docs/concept/version). # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest] google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2101,6 +2105,8 @@ def patch_project_location_agent_intent(name, google_cloud_dialogflow_cx_v3beta1 # Processes a natural language query and returns structured, actionable data as # a result. This method is not idempotent, because it may cause session entity # types to be updated, which in turn might affect results of future queries. + # Note: Always use agent versions for production traffic. See [Versions and + # environments](https://cloud.google.com/dialogflow/cx/docs/concept/version). # @param [String] session # Required. The name of the session this query is sent to. Format: `projects// # locations//agents//sessions/` or `projects//locations//agents//environments// @@ -2109,7 +2115,9 @@ def patch_project_location_agent_intent(name, google_cloud_dialogflow_cx_v3beta1 # It can be a random number or some type of session identifiers (preferably # hashed). The length of the `Session ID` must not exceed 36 characters. For # more information, see the [sessions guide](https://cloud.google.com/dialogflow/ - # cx/docs/concept/session). + # cx/docs/concept/session). Note: Always use agent versions for production + # traffic. See [Versions and environments](https://cloud.google.com/dialogflow/ + # cx/docs/concept/version). # @param [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DetectIntentRequest] google_cloud_dialogflow_cx_v3beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/dialogflow_v3beta1/synth.metadata b/generated/google/apis/dialogflow_v3beta1/synth.metadata index 7f5122644f5..8b31b22f3e9 100644 --- a/generated/google/apis/dialogflow_v3beta1/synth.metadata +++ b/generated/google/apis/dialogflow_v3beta1/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/google-api-ruby-client.git", - "sha": "e317a0f5e6109142be13031fa9e9baee4d2f897e" + "sha": "1ca7ec3e2f29bdd2184cd075ab5ad2f60c9109fc" } } ]