Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Agent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3beta1/classes.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb,
lib/google/apis/dialogflow_v3beta1/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) ⇒ GoogleCloudDialogflowCxV3beta1Agent

Returns a new instance of GoogleCloudDialogflowCxV3beta1Agent.



4632
4633
4634
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4632

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#advanced_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AdvancedSettings

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:



4481
4482
4483
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4481

def advanced_settings
  @advanced_settings
end

#answer_feedback_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentAnswerFeedbackSettings

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

Returns:



4486
4487
4488
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4486

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) 


4493
4494
4495
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4493

def avatar_uri
  @avatar_uri
end

#bigquery_export_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BigQueryExportSettings

The settings of BigQuery export. Corresponds to the JSON property bigqueryExportSettings

Returns:



4498
4499
4500
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4498

def bigquery_export_settings
  @bigquery_export_settings
end

#client_certificate_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentClientCertificateSettings

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

Returns:



4503
4504
4505
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4503

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) 


4511
4512
4513
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4511

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) 


4517
4518
4519
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4517

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) 


4522
4523
4524
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4522

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) 


4528
4529
4530
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4528

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) 


4534
4535
4536
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4534

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) 


4541
4542
4543
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4541

def enable_stackdriver_logging
  @enable_stackdriver_logging
end

#gen_app_builder_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentGenAppBuilderSettings

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

Returns:



4547
4548
4549
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4547

def gen_app_builder_settings
  @gen_app_builder_settings
end

#git_integration_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentGitIntegrationSettings

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

Returns:



4552
4553
4554
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4552

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) 


4558
4559
4560
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4558

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) 


4566
4567
4568
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4566

def name
  @name
end

#personalization_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AgentPersonalizationSettings

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

Returns:



4571
4572
4573
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4571

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) 


4577
4578
4579
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4577

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) 


4584
4585
4586
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4584

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) 


4591
4592
4593
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4591

def security_settings
  @security_settings
end

#speech_to_text_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SpeechToTextSettings

Settings related to speech recognition. Corresponds to the JSON property speechToTextSettings

Returns:



4596
4597
4598
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4596

def speech_to_text_settings
  @speech_to_text_settings
end

#start_flow ⇒ String

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/. Currently only the default start flow with id "00000000-0000-0000-0000-000000000000" is allowed. Corresponds to the JSON property startFlow

Returns:

  • (String) 


4604
4605
4606
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4604

def start_flow
  @start_flow
end

#start_playbook ⇒ String

Name of the start playbook in this agent. A start playbook will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//playbooks/. Currently only the default playbook with id "00000000-0000-0000-0000- 000000000000" is allowed. Corresponds to the JSON property startPlaybook

Returns:

  • (String) 


4613
4614
4615
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4613

def start_playbook
  @start_playbook
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>) 


4619
4620
4621
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4619

def supported_language_codes
  @supported_language_codes
end

#text_to_speech_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1TextToSpeechSettings

Settings related to speech synthesizing. Corresponds to the JSON property textToSpeechSettings

Returns:



4624
4625
4626
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4624

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) 


4630
4631
4632
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4630

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4637

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)
  @bigquery_export_settings = args[:bigquery_export_settings] if args.key?(:bigquery_export_settings)
  @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)
  @start_playbook = args[:start_playbook] if args.key?(:start_playbook)
  @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