Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb
Overview
Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..
Instance Attribute Summary collapse
-
#advanced_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
-
#avatar_uri ⇒ String
The URI of the agent's avatar.
-
#default_language_code ⇒ String
Required.
-
#description ⇒ String
The description of the agent.
-
#display_name ⇒ String
Required.
-
#enable_spell_correction ⇒ Boolean
(also: #enable_spell_correction?)
Indicates if automatic spell correction is enabled in detect intent requests.
-
#enable_stackdriver_logging ⇒ Boolean
(also: #enable_stackdriver_logging?)
Indicates if stackdriver logging is enabled for the agent.
-
#locked ⇒ Boolean
(also: #locked?)
Indicates whether the agent is locked for changes.
-
#name ⇒ String
The unique identifier of the agent.
-
#security_settings ⇒ String
Name of the SecuritySettings reference for the agent.
-
#speech_to_text_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SpeechToTextSettings
Settings related to speech recognition.
-
#start_flow ⇒ String
Immutable.
-
#supported_language_codes ⇒ Array<String>
The list of all languages supported by the agent (except for the
default_language_code
). -
#text_to_speech_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TextToSpeechSettings
Settings related to speech synthesizing.
-
#time_zone ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Agent
constructor
A new instance of GoogleCloudDialogflowCxV3Agent.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Agent
Returns a new instance of GoogleCloudDialogflowCxV3Agent.
193 194 195 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 193 def initialize(**args) update!(**args) end |
Instance Attribute Details
#advanced_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
Settings exposed at lower level overrides the settings exposed at higher level.
Overriding occurs at the sub-setting level. For example, the
playback_interruption_settings at fulfillment level only overrides the
playback_interruption_settings at the agent level, leaving other settings at
the agent level unchanged. DTMF settings does not override each other. DTMF
settings set at different levels define DTMF detections running in parallel.
Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
Corresponds to the JSON property advancedSettings
103 104 105 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 103 def advanced_settings @advanced_settings end |
#avatar_uri ⇒ String
The URI of the agent's avatar. Avatars are used throughout the Dialogflow
console and in the self-hosted Web Demo integration.
Corresponds to the JSON property avatarUri
110 111 112 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 110 def avatar_uri @avatar_uri end |
#default_language_code ⇒ String
Required. Immutable. The default language of the agent as a language tag. See
Language Support for a list of the currently supported language codes. This field
cannot be set by the Agents.UpdateAgent method.
Corresponds to the JSON property defaultLanguageCode
118 119 120 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 118 def default_language_code @default_language_code end |
#description ⇒ String
The description of the agent. The maximum length is 500 characters. If
exceeded, the request is rejected.
Corresponds to the JSON property description
124 125 126 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 124 def description @description end |
#display_name ⇒ String
Required. The human-readable name of the agent, unique within the location.
Corresponds to the JSON property displayName
129 130 131 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 129 def display_name @display_name end |
#enable_spell_correction ⇒ Boolean Also known as: enable_spell_correction?
Indicates if automatic spell correction is enabled in detect intent requests.
Corresponds to the JSON property enableSpellCorrection
134 135 136 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 134 def enable_spell_correction @enable_spell_correction end |
#enable_stackdriver_logging ⇒ Boolean Also known as: enable_stackdriver_logging?
Indicates if stackdriver logging is enabled for the agent. Please use agent.
advanced_settings instead.
Corresponds to the JSON property enableStackdriverLogging
141 142 143 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 141 def enable_stackdriver_logging @enable_stackdriver_logging end |
#locked ⇒ Boolean Also known as: locked?
Indicates whether the agent is locked for changes. If the agent is locked,
modifications to the agent will be rejected except for RestoreAgent.
Corresponds to the JSON property locked
148 149 150 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 148 def locked @locked end |
#name ⇒ String
The unique identifier of the agent. Required for the Agents.UpdateAgent method.
Agents.CreateAgent populates the name automatically. Format: projects//
locations//agents/
.
Corresponds to the JSON property name
156 157 158 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 156 def name @name end |
#security_settings ⇒ String
Name of the SecuritySettings reference for the agent. Format: projects//
locations//securitySettings/
.
Corresponds to the JSON property securitySettings
162 163 164 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 162 def security_settings @security_settings end |
#speech_to_text_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SpeechToTextSettings
Settings related to speech recognition.
Corresponds to the JSON property speechToTextSettings
167 168 169 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 167 def speech_to_text_settings @speech_to_text_settings end |
#start_flow ⇒ String
Immutable. Name of the start flow in this agent. A start flow will be
automatically created when the agent is created, and can only be deleted by
deleting the agent. Format: projects//locations//agents//flows/
.
Corresponds to the JSON property startFlow
174 175 176 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 174 def start_flow @start_flow end |
#supported_language_codes ⇒ Array<String>
The list of all languages supported by the agent (except for the
default_language_code
).
Corresponds to the JSON property supportedLanguageCodes
180 181 182 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 180 def supported_language_codes @supported_language_codes end |
#text_to_speech_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3TextToSpeechSettings
Settings related to speech synthesizing.
Corresponds to the JSON property textToSpeechSettings
185 186 187 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 185 def text_to_speech_settings @text_to_speech_settings end |
#time_zone ⇒ String
Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
Corresponds to the JSON property timeZone
191 192 193 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 191 def time_zone @time_zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 198 def update!(**args) @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings) @avatar_uri = args[:avatar_uri] if args.key?(:avatar_uri) @default_language_code = args[:default_language_code] if args.key?(:default_language_code) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @enable_spell_correction = args[:enable_spell_correction] if args.key?(:enable_spell_correction) @enable_stackdriver_logging = args[:enable_stackdriver_logging] if args.key?(:enable_stackdriver_logging) @locked = args[:locked] if args.key?(:locked) @name = args[:name] if args.key?(:name) @security_settings = args[:security_settings] if args.key?(:security_settings) @speech_to_text_settings = args[:speech_to_text_settings] if args.key?(:speech_to_text_settings) @start_flow = args[:start_flow] if args.key?(:start_flow) @supported_language_codes = args[:supported_language_codes] if args.key?(:supported_language_codes) @text_to_speech_settings = args[:text_to_speech_settings] if args.key?(:text_to_speech_settings) @time_zone = args[:time_zone] if args.key?(:time_zone) end |