Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent

Inherits:
Object
  • Object
show all
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, TransitionRouteGroups and so on to manage the conversation flows.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Agent

Returns a new instance of GoogleCloudDialogflowCxV3Agent.



352
353
354
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 352

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

Returns:



216
217
218
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 216

def advanced_settings
  @advanced_settings
end

#answer_feedback_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentAnswerFeedbackSettings

Settings for answer feedback collection. Corresponds to the JSON property answerFeedbackSettings

Returns:



221
222
223
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 221

def answer_feedback_settings
  @answer_feedback_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

Returns:

  • (String) 


228
229
230
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 228

def avatar_uri
  @avatar_uri
end

#client_certificate_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentClientCertificateSettings

Settings for custom client certificates. Corresponds to the JSON property clientCertificateSettings

Returns:



233
234
235
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 233

def client_certificate_settings
  @client_certificate_settings
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

Returns:

  • (String) 


241
242
243
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 241

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

Returns:

  • (String) 


247
248
249
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 247

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

Returns:

  • (String) 


252
253
254
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 252

def display_name
  @display_name
end

#enable_multi_language_training ⇒ Boolean Also known as: enable_multi_language_training?

Optional. Enable training multi-lingual models for this agent. These models will be trained on all the languages supported by the agent. Corresponds to the JSON property enableMultiLanguageTraining

Returns:

  • (Boolean) 


258
259
260
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 258

def enable_multi_language_training
  @enable_multi_language_training
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

Returns:

  • (Boolean) 


264
265
266
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 264

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

Returns:

  • (Boolean) 


271
272
273
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 271

def enable_stackdriver_logging
  @enable_stackdriver_logging
end

#gen_app_builder_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentGenAppBuilderSettings

Settings for Gen App Builder. Corresponds to the JSON property genAppBuilderSettings

Returns:



277
278
279
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 277

def gen_app_builder_settings
  @gen_app_builder_settings
end

#git_integration_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentGitIntegrationSettings

Settings for connecting to Git repository for an agent. Corresponds to the JSON property gitIntegrationSettings

Returns:



282
283
284
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 282

def git_integration_settings
  @git_integration_settings
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

Returns:

  • (Boolean) 


288
289
290
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 288

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

Returns:

  • (String) 


296
297
298
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 296

def name
  @name
end

#personalization_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AgentPersonalizationSettings

Settings for end user personalization. Corresponds to the JSON property personalizationSettings

Returns:



301
302
303
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 301

def personalization_settings
  @personalization_settings
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Optional. Output only. A read only boolean field reflecting Zone Isolation status of the agent. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


307
308
309
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 307

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Optional. Output only. A read only boolean field reflecting Zone Separation status of the agent. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


314
315
316
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 314

def satisfies_pzs
  @satisfies_pzs
end

#security_settings ⇒ String

Name of the SecuritySettings reference for the agent. Format: projects// locations//securitySettings/. Corresponds to the JSON property securitySettings

Returns:

  • (String) 


321
322
323
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 321

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

Returns:



326
327
328
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 326

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

Returns:

  • (String) 


333
334
335
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 333

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

Returns:

  • (Array<String>) 


339
340
341
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 339

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

Returns:



344
345
346
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 344

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

Returns:

  • (String) 


350
351
352
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 350

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 357

def update!(**args)
  @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
  @answer_feedback_settings = args[:answer_feedback_settings] if args.key?(:answer_feedback_settings)
  @avatar_uri = args[:avatar_uri] if args.key?(:avatar_uri)
  @client_certificate_settings = args[:client_certificate_settings] if args.key?(:client_certificate_settings)
  @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_multi_language_training = args[:enable_multi_language_training] if args.key?(:enable_multi_language_training)
  @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)
  @gen_app_builder_settings = args[:gen_app_builder_settings] if args.key?(:gen_app_builder_settings)
  @git_integration_settings = args[:git_integration_settings] if args.key?(:git_integration_settings)
  @locked = args[:locked] if args.key?(:locked)
  @name = args[:name] if args.key?(:name)
  @personalization_settings = args[:personalization_settings] if args.key?(:personalization_settings)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @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