google-api-ruby-client/generated/google/apis/dialogflow_v3/classes.rb

5452 lines
238 KiB
Ruby
Raw Normal View History

feat: Automated regeneration of dialogflow v3 client (#1661) This PR was generated using Autosynth. :rainbow: <details><summary>Log from Synthtool</summary> ``` 2020-12-08 02:17:44,827 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py. On branch autosynth-dialogflow-v3 nothing to commit, working tree clean 2020-12-08 02:17:44,857 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dialogflow v3 DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth dialogflow v3 bundle install Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will break this application for all non-root users on this machine. The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`. Fetching gem metadata from https://rubygems.org/......... Fetching gem metadata from https://rubygems.org/. Resolving dependencies... Fetching rake 11.3.0 Installing rake 11.3.0 Fetching concurrent-ruby 1.1.7 Installing concurrent-ruby 1.1.7 Fetching i18n 1.8.5 Installing i18n 1.8.5 Fetching minitest 5.14.2 Installing minitest 5.14.2 Fetching thread_safe 0.3.6 Installing thread_safe 0.3.6 Fetching tzinfo 1.2.8 Installing tzinfo 1.2.8 Fetching activesupport 5.0.7.2 Installing activesupport 5.0.7.2 Fetching public_suffix 4.0.6 Installing public_suffix 4.0.6 Fetching addressable 2.7.0 Installing addressable 2.7.0 Fetching ast 2.4.1 Installing ast 2.4.1 Using bundler 2.1.4 Fetching byebug 11.1.3 Installing byebug 11.1.3 with native extensions Fetching coderay 1.1.3 Installing coderay 1.1.3 Fetching json 2.3.1 Installing json 2.3.1 with native extensions Fetching docile 1.3.2 Installing docile 1.3.2 Fetching simplecov-html 0.10.2 Installing simplecov-html 0.10.2 Fetching simplecov 0.16.1 Installing simplecov 0.16.1 Using sync 0.5.0 Fetching tins 1.26.0 Installing tins 1.26.0 Fetching term-ansicolor 1.7.1 Installing term-ansicolor 1.7.1 Fetching thor 0.20.3 Installing thor 0.20.3 Fetching coveralls 0.8.23 Installing coveralls 0.8.23 Fetching crack 0.4.4 Installing crack 0.4.4 Fetching declarative 0.0.20 Installing declarative 0.0.20 Fetching declarative-option 0.1.0 Installing declarative-option 0.1.0 Fetching diff-lcs 1.4.4 Installing diff-lcs 1.4.4 Fetching dotenv 2.7.6 Installing dotenv 2.7.6 Fetching fakefs 0.20.1 Installing fakefs 0.20.1 Fetching multipart-post 2.1.1 Installing multipart-post 2.1.1 Fetching ruby2_keywords 0.0.2 Installing ruby2_keywords 0.0.2 Fetching faraday 1.1.0 Installing faraday 1.1.0 Fetching gems 1.2.0 Installing gems 1.2.0 Fetching github-markup 1.7.0 Installing github-markup 1.7.0 Fetching jwt 2.2.2 Installing jwt 2.2.2 Fetching memoist 0.16.2 Installing memoist 0.16.2 Fetching multi_json 1.15.0 Installing multi_json 1.15.0 Fetching os 0.9.6 Installing os 0.9.6 Fetching signet 0.14.0 Installing signet 0.14.0 Fetching googleauth 0.14.0 Installing googleauth 0.14.0 Fetching httpclient 2.8.3 Installing httpclient 2.8.3 Fetching mini_mime 1.0.2 Installing mini_mime 1.0.2 Fetching uber 0.1.0 Installing uber 0.1.0 Fetching representable 3.0.4 Installing representable 3.0.4 Fetching retriable 3.1.2 Installing retriable 3.1.2 Fetching rexml 3.2.4 Installing rexml 3.2.4 Using google-api-client 0.51.0 from source at `.` Fetching google-id-token 1.4.2 Installing google-id-token 1.4.2 Fetching hashdiff 1.0.1 Installing hashdiff 1.0.1 Fetching mime-types-data 3.2020.1104 Installing mime-types-data 3.2020.1104 Fetching mime-types 3.3.1 Installing mime-types 3.3.1 Fetching multi_xml 0.6.0 Installing multi_xml 0.6.0 Fetching httparty 0.18.1 Installing httparty 0.18.1 Fetching rspec-support 3.10.0 Installing rspec-support 3.10.0 Fetching rspec-core 3.10.0 Installing rspec-core 3.10.0 Fetching rspec-expectations 3.10.0 Installing rspec-expectations 3.10.0 Fetching rspec-mocks 3.10.0 Installing rspec-mocks 3.10.0 Fetching rspec 3.10.0 Installing rspec 3.10.0 Fetching json_spec 1.1.5 Installing json_spec 1.1.5 Fetching launchy 2.5.0 Installing launchy 2.5.0 Fetching little-plugger 1.1.4 Installing little-plugger 1.1.4 Fetching logging 2.3.0 Installing logging 2.3.0 Fetching method_source 1.0.0 Installing method_source 1.0.0 Fetching opencensus 0.5.0 Installing opencensus 0.5.0 Fetching parallel 1.20.1 Installing parallel 1.20.1 Fetching parser 2.7.2.0 Installing parser 2.7.2.0 Fetching powerpack 0.1.3 Installing powerpack 0.1.3 Fetching pry 0.13.1 Installing pry 0.13.1 Fetching pry-byebug 3.9.0 Installing pry-byebug 3.9.0 Fetching yard 0.9.25 Installing yard 0.9.25 Fetching pry-doc 0.13.5 Installing pry-doc 0.13.5 Fetching rainbow 2.2.2 Installing rainbow 2.2.2 with native extensions Fetching redcarpet 3.5.0 Installing redcarpet 3.5.0 with native extensions Fetching redis 3.3.5 Installing redis 3.3.5 Fetching rmail 1.1.4 Installing rmail 1.1.4 Fetching ruby-progressbar 1.10.1 Installing ruby-progressbar 1.10.1 Fetching unicode-display_width 1.7.0 Installing unicode-display_width 1.7.0 Fetching rubocop 0.49.1 Installing rubocop 0.49.1 Fetching webmock 2.3.2 Installing webmock 2.3.2 Bundle complete! 31 Gemfile dependencies, 78 gems now installed. Use `bundle info [gemname]` to see where a bundled gem is installed. Post-install message from i18n: HEADS UP! i18n 1.1 changed fallbacks to exclude default locale. But that may break your application. If you are upgrading your Rails application from an older version of Rails: Please check your Rails app for 'config.i18n.fallbacks = true'. If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be 'config.i18n.fallbacks = [I18n.default_locale]'. If not, fallbacks will be broken in your app by I18n 1.1.x. If you are starting a NEW Rails application, you can ignore this notice. For more info see: https://github.com/svenfuchs/i18n/releases/tag/v1.1.0 Post-install message from httparty: When you HTTParty, you must party hard! echo a | bundle exec bin/generate-api gen generated --api=dialogflow.v3 --names-out=/workspace/api_names_out.yaml Loading dialogflow, version v3 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/dialogflow.v3.json create google/apis/dialogflow_v3.rb create google/apis/dialogflow_v3/service.rb create google/apis/dialogflow_v3/classes.rb create google/apis/dialogflow_v3/representations.rb conflict /workspace/api_names_out.yaml Overwrite /workspace/api_names_out.yaml? (enter "h" for help) [Ynaqdhm] a force /workspace/api_names_out.yaml 2020-12-08 02:18:11,536 synthtool [DEBUG] > Wrote metadata to generated/google/apis/dialogflow_v3/synth.metadata. DEBUG:synthtool:Wrote metadata to generated/google/apis/dialogflow_v3/synth.metadata. ``` </details> Full log will be available here: https://source.cloud.google.com/results/invocations/35e86c3e-290b-4047-a5db-b00e23fed8ba/targets - [ ] To automatically regenerate this PR, check this box.
2020-12-08 10:32:06 +00:00
# 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 DialogflowV3
# Metadata associated with the long running operation for Versions.CreateVersion.
class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata
include Google::Apis::Core::Hashable
# Name of the created version. Format: `projects//locations//agents//flows//
# versions/`.
# 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)
@version = args[:version] if args.key?(:version)
end
end
# 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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo>]
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::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction]
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::DialogflowV3::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::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText]
attr_accessor :output_audio_text
# Returns a response containing a custom, platform-specific payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Specifies an audio clip to be played by the client as part of the response.
# Corresponds to the JSON property `playAudio`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio]
attr_accessor :play_audio
# The text response message.
# Corresponds to the JSON property `text`
# @return [Google::Apis::DialogflowV3::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)
@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<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# 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 live agent.
# Dialogflow only uses this to determine which conversations were handed off to
# a human agent for measurement purposes. What else to do with this signal is up
# to you and your handoff procedures. You may set this, for example: * In the
# entry_fulfillment of a Page if entering the page indicates something went
# extremely wrong in the conversation. * In a webhook response when you
# determine that the customer issue can only be handled by a human.
class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff
include Google::Apis::Core::Hashable
# Custom metadata for your handoff procedure. Dialogflow doesn't impose any
# structure on this.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metadata = args[:metadata] if args.key?(:metadata)
end
end
# Represents an audio message that is composed of both segments synthesized from
# the Dialogflow agent prompts and ones hosted externally at the specified URIs.
# The external URIs are specified via play_audio. This message is generated by
# Dialogflow only and not supposed to be defined by the user.
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio
include Google::Apis::Core::Hashable
# Segments this audio response is composed of.
# Corresponds to the JSON property `segments`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment>]
attr_accessor :segments
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@segments = args[:segments] if args.key?(:segments)
end
end
# Represents one segment of audio.
class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment
include Google::Apis::Core::Hashable
# 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 GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText
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 GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio
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 GoogleCloudDialogflowCxV3beta1ResponseMessageText
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<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)
@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<String,Object>]
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::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo]
attr_accessor :fulfillment_info
# Represents intent information communicated to the webhook.
# Corresponds to the JSON property `intentInfo`
# @return [Google::Apis::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
attr_accessor :messages
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1PageInfo]
attr_accessor :page_info
# Custom data set in QueryParameters.payload.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV3::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<String,Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue>]
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::DialogflowV3::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse]
attr_accessor :fulfillment_response
# Represents page information communicated to and from the webhook.
# Corresponds to the JSON property `pageInfo`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1PageInfo]
attr_accessor :page_info
# Value to append directly to QueryResult.webhook_payloads.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
attr_accessor :payload
# Represents session information communicated to and from the webhook.
# Corresponds to the JSON property `sessionInfo`
# @return [Google::Apis::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1ResponseMessage>]
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
# 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 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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2EntityType>]
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 GoogleCloudDialogflowV2BatchUpdateIntentsResponse
include Google::Apis::Core::Hashable
# The collection of updated or created intents.
# Corresponds to the JSON property `intents`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2Intent>]
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
# Dialogflow contexts are similar to natural language context. If a person says
# to you "they are orange", you need context in order to understand what "they"
# is referring to. Similarly, for Dialogflow to handle an end-user expression
# like that, it needs to be provided with context in order to correctly match an
# intent. Using contexts, you can control the flow of a conversation. You can
# configure contexts for an intent by setting input and output contexts, which
# are identified by string names. When an intent is matched, any configured
# output contexts for that intent become active. While any contexts are active,
# Dialogflow is more likely to match intents that are configured with input
# contexts that correspond to the currently active contexts. For more
# information about context, see the [Contexts guide](https://cloud.google.com/
# dialogflow/docs/contexts-overview).
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<String,Object>]
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 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::DialogflowV3::GoogleRpcStatus]
attr_accessor :error_status
# Represents a message posted into a conversation.
# Corresponds to the JSON property `newMessagePayload`
# @return [Google::Apis::DialogflowV3::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
# Each intent parameter has a type, called the entity type, which dictates
# exactly how data from an end-user expression is extracted. Dialogflow provides
# predefined system entities that can match many common types of data. For
# example, there are system entities for matching dates, times, colors, email
# addresses, and so on. You can also create your own custom entities for
# matching custom data. For example, you could define a vegetable entity that
# can match the types of vegetables available for purchase with a grocery store
# agent. For more information, see the [Entity guide](https://cloud.google.com/
# dialogflow/docs/entities-overview).
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2EntityTypeEntity>]
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 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<String>]
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 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<String,Object>]
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 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
# An intent categorizes an end-user's intention for one conversation turn. For
# each agent, you define many intents, where your combined intents can handle a
# complete conversation. When an end-user writes or says something, referred to
# as an end-user expression or end-user input, Dialogflow matches the end-user
# input to the best intent in your agent. Matching an intent is also known as
# intent classification. For more information, see the [intent guide](https://
# cloud.google.com/dialogflow/docs/intents-overview).
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<String>]
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<String>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentFollowupIntentInfo>]
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<String>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessage>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2Context>]
attr_accessor :output_contexts
# Optional. The collection of parameters associated with the intent.
# Corresponds to the JSON property `parameters`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentParameter>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentTrainingPhrase>]
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
# 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::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard]
attr_accessor :browse_carousel_card
# The card response message.
# Corresponds to the JSON property `card`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageCard]
attr_accessor :card
# The card for presenting a carousel of options to select from.
# Corresponds to the JSON property `carouselSelect`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageCarouselSelect]
attr_accessor :carousel_select
# The image response message.
# Corresponds to the JSON property `image`
# @return [Google::Apis::DialogflowV3::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::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowV2IntentMessageListSelect]
attr_accessor :list_select
# The media content card for Actions on Google.
# Corresponds to the JSON property `mediaContent`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageMediaContent]
attr_accessor :media_content
# A custom platform-specific response.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
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::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowV2IntentMessageSimpleResponses]
attr_accessor :simple_responses
# The collection of suggestions.
# Corresponds to the JSON property `suggestions`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageSuggestions]
attr_accessor :suggestions
# Table card for Actions on Google.
# Corresponds to the JSON property `tableCard`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageTableCard]
attr_accessor :table_card
# The text response message.
# Corresponds to the JSON property `text`
# @return [Google::Apis::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageBasicCardButton>]
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::DialogflowV3::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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem>]
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::DialogflowV3::GoogleCloudDialogflowV2IntentMessageImage]
attr_accessor :image
# Actions on Google action to open a given url.
# Corresponds to the JSON property `openUriAction`
# @return [Google::Apis::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageCardButton>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageCarouselSelectItem>]
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::DialogflowV3::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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageListSelectItem>]
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::DialogflowV3::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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject>]
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::DialogflowV3::GoogleCloudDialogflowV2IntentMessageImage]
attr_accessor :icon
# The image response message.
# Corresponds to the JSON property `largeImage`
# @return [Google::Apis::DialogflowV3::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<String>]
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<String>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageSimpleResponse>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageSuggestion>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageBasicCardButton>]
attr_accessor :buttons
# Optional. Display properties for the columns in this table.
# Corresponds to the JSON property `columnProperties`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageColumnProperties>]
attr_accessor :column_properties
# The image response message.
# Corresponds to the JSON property `image`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageImage]
attr_accessor :image
# Optional. Rows in this table of data.
# Corresponds to the JSON property `rows`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageTableCardRow>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessageTableCardCell>]
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<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
# 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<String>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentTrainingPhrasePart>]
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
# 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::DialogflowV3::GoogleCloudDialogflowV2MessageAnnotation]
attr_accessor :message_annotation
# The unique identifier of the message. Format: `projects//locations//
# 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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2AnnotatedMessagePart>]
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 Trial Edition agents and populated with the caller ID in [E.
# 164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
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 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<String,Object>]
attr_accessor :diagnostic_info
# The collection of rich messages to present to the user.
# Corresponds to the JSON property `fulfillmentMessages`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessage>]
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
# An intent categorizes an end-user's intention for one conversation turn. For
# each agent, you define many intents, where your combined intents can handle a
# complete conversation. When an end-user writes or says something, referred to
# as an end-user expression or end-user input, Dialogflow matches the end-user
# input to the best intent in your agent. Matching an intent is also known as
# intent classification. For more information, see the [intent guide](https://
# cloud.google.com/dialogflow/docs/intents-overview).
# Corresponds to the JSON property `intent`
# @return [Google::Apis::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2Context>]
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<String,Object>]
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.DetectIntent, it
# needs to be configured in DetectIntentRequest.query_params. For Participants.
# StreamingDetectIntent, 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::DialogflowV3::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<String,Object>]
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 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
# 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.DetectIntent, it
# needs to be configured in DetectIntentRequest.query_params. For Participants.
# StreamingDetectIntent, 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::DialogflowV3::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
# A session represents a conversation between a Dialogflow agent and an end-user.
# You can create special entities, called session entities, during a session.
# Session entities can extend or replace custom entity types and only exist
# during the session that they were created for. All session data, including
# session entities, is stored by Dialogflow for 20 minutes. For more information,
# see the [session entity guide](https://cloud.google.com/dialogflow/docs/
# entities-session).
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2EntityTypeEntity>]
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 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::DialogflowV3::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::DialogflowV3::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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2IntentMessage>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2Context>]
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<String,Object>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2SessionEntityType>]
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
# 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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1EntityType>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1Intent>]
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
# Dialogflow contexts are similar to natural language context. If a person says
# to you "they are orange", you need context in order to understand what "they"
# is referring to. Similarly, for Dialogflow to handle an end-user expression
# like that, it needs to be provided with context in order to correctly match an
# intent. Using contexts, you can control the flow of a conversation. You can
# configure contexts for an intent by setting input and output contexts, which
# are identified by string names. When an intent is matched, any configured
# output contexts for that intent become active. While any contexts are active,
# Dialogflow is more likely to match intents that are configured with input
# contexts that correspond to the currently active contexts. For more
# information about context, see the [Contexts guide](https://cloud.google.com/
# dialogflow/docs/contexts-overview).
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. Supported formats: - `projects/
# /agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`
# , - `projects//agent/environments//users//sessions//contexts/`, - `projects//
# locations//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<String,Object>]
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
# Each intent parameter has a type, called the entity type, which dictates
# exactly how data from an end-user expression is extracted. Dialogflow provides
# predefined system entities that can match many common types of data. For
# example, there are system entities for matching dates, times, colors, email
# addresses, and so on. You can also create your own custom entities for
# matching custom data. For example, you could define a vegetable entity that
# can match the types of vegetables available for purchase with a grocery store
# agent. For more information, see the [Entity guide](https://cloud.google.com/
# dialogflow/docs/entities-overview).
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1EntityTypeEntity>]
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. Supported
# formats: - `projects//agent/entityTypes/` - `projects//locations//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<String>]
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<String,Object>]
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
# An intent categorizes an end-user's intention for one conversation turn. For
# each agent, you define many intents, where your combined intents can handle a
# complete conversation. When an end-user writes or says something, referred to
# as an end-user expression or end-user input, Dialogflow matches the end-user
# input to the best intent in your agent. Matching an intent is also known as
# intent classification. For more information, see the [intent guide](https://
# cloud.google.com/dialogflow/docs/intents-overview).
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<String>]
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<String>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo>]
attr_accessor :followup_intent_info
# Optional. The list of context names required for this intent to be triggered.
# Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//
# agent/sessions/-/contexts/`
# Corresponds to the JSON property `inputContextNames`
# @return [Array<String>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessage>]
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. Supported formats: - `
# projects//agent/intents/` - `projects//locations//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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1Context>]
attr_accessor :output_contexts
# Optional. The collection of parameters associated with the intent.
# Corresponds to the JSON property `parameters`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentParameter>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentTrainingPhrase>]
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::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard]
attr_accessor :browse_carousel_card
# The card response message.
# Corresponds to the JSON property `card`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageCard]
attr_accessor :card
# The card for presenting a carousel of options to select from.
# Corresponds to the JSON property `carouselSelect`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect]
attr_accessor :carousel_select
# The image response message.
# Corresponds to the JSON property `image`
# @return [Google::Apis::DialogflowV3::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::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageListSelect]
attr_accessor :list_select
# The media content card for Actions on Google.
# Corresponds to the JSON property `mediaContent`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageMediaContent]
attr_accessor :media_content
# A custom platform-specific response.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
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::DialogflowV3::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::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard]
attr_accessor :rbm_standalone_rich_card
# Rich Business Messaging (RBM) text response with suggestions.
# Corresponds to the JSON property `rbmText`
# @return [Google::Apis::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses]
attr_accessor :simple_responses
# The collection of suggestions.
# Corresponds to the JSON property `suggestions`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageSuggestions]
attr_accessor :suggestions
# Table card for Actions on Google.
# Corresponds to the JSON property `tableCard`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageTableCard]
attr_accessor :table_card
# Plays audio from a file in Telephony Gateway.
# Corresponds to the JSON property `telephonyPlayAudio`
# @return [Google::Apis::DialogflowV3::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::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech]
attr_accessor :telephony_synthesize_speech
# Transfers the call in Telephony Gateway.
# Corresponds to the JSON property `telephonyTransferCall`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall]
attr_accessor :telephony_transfer_call
# The text response message.
# Corresponds to the JSON property `text`
# @return [Google::Apis::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton>]
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::DialogflowV3::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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem>]
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::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageImage]
attr_accessor :image
# Actions on Google action to open a given url.
# Corresponds to the JSON property `openUriAction`
# @return [Google::Apis::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageCardButton>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem>]
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::DialogflowV3::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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageListSelectItem>]
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::DialogflowV3::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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject>]
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::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageImage]
attr_accessor :icon
# The image response message.
# Corresponds to the JSON property `largeImage`
# @return [Google::Apis::DialogflowV3::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<String>]
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::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia]
attr_accessor :media
# Optional. List of suggestions to include in the card.
# Corresponds to the JSON property `suggestions`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent>]
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::DialogflowV3::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::DialogflowV3::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::DialogflowV3::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::DialogflowV3::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::DialogflowV3::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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion>]
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<String>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageSuggestion>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton>]
attr_accessor :buttons
# Optional. Display properties for the columns in this table.
# Corresponds to the JSON property `columnProperties`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageColumnProperties>]
attr_accessor :column_properties
# The image response message.
# Corresponds to the JSON property `image`
# @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageImage]
attr_accessor :image
# Optional. Rows in this table of data.
# Corresponds to the JSON property `rows`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageTableCardRow>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessageTableCardCell>]
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<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
# 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<String>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer>]
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
# 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 Trial Edition agents and populated with the caller ID in [E.
# 164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.
# Corresponds to the JSON property `payload`
# @return [Hash<String,Object>]
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<String,Object>]
attr_accessor :diagnostic_info
# The collection of rich messages to present to the user.
# Corresponds to the JSON property `fulfillmentMessages`
# @return [Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessage>]
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
# An intent categorizes an end-user's intention for one conversation turn. For
# each agent, you define many intents, where your combined intents can handle a
# complete conversation. When an end-user writes or says something, referred to
# as an end-user expression or end-user input, Dialogflow matches the end-user
# input to the best intent in your agent. Matching an intent is also known as
# intent classification. For more information, see the [intent guide](https://
# cloud.google.com/dialogflow/docs/intents-overview).
# Corresponds to the JSON property `intent`
# @return [Google::Apis::DialogflowV3::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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1Context>]
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<String,Object>]
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.DetectIntent, it
# needs to be configured in DetectIntentRequest.query_params. For Participants.
# StreamingDetectIntent, 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::DialogflowV3::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<String,Object>]
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.DetectIntent, it
# needs to be configured in DetectIntentRequest.query_params. For Participants.
# StreamingDetectIntent, 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::DialogflowV3::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
# A session represents a conversation between a Dialogflow agent and an end-user.
# You can create special entities, called session entities, during a session.
# Session entities can extend or replace custom entity types and only exist
# during the session that they were created for. All session data, including
# session entities, is stored by Dialogflow for 20 minutes. For more information,
# see the [session entity guide](https://cloud.google.com/dialogflow/docs/
# entities-session).
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1EntityTypeEntity>]
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. Supported formats:
# - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/
# sessions//entityTypes/` - `projects//agent/environments//users//sessions//
# entityTypes/` - `projects//locations//agent/environments/ /users//sessions//
# entityTypes/` If `Location ID` is not specified we assume default 'us'
# location. 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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1QueryResult>]
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::DialogflowV3::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::DialogflowV3::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. Supported formats: - `projects//agent/
# sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/
# environments//users//sessions/`, - `projects//locations//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::DialogflowV3::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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessage>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1Context>]
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<String,Object>]
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<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SessionEntityType>]
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 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<Google::Apis::DialogflowV3::GoogleLongrunningOperation>]
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::DialogflowV3::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<String,Object>]
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<String,Object>]
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<Hash<String,Object>>]
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
end
end
end