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.



4228
4229
4230
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4228

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:



4101
4102
4103
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4101

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:



4106
4107
4108
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4106

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) 


4113
4114
4115
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4113

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

Returns:

  • (String) 


4121
4122
4123
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4121

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) 


4127
4128
4129
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4127

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) 


4132
4133
4134
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4132

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) 


4138
4139
4140
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4138

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) 


4144
4145
4146
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4144

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) 


4151
4152
4153
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4151

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:



4157
4158
4159
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4157

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:



4162
4163
4164
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4162

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) 


4168
4169
4170
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4168

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) 


4176
4177
4178
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4176

def name
  @name
end

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

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

Returns:



4181
4182
4183
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4181

def personalization_settings
  @personalization_settings
end

#security_settings ⇒ String

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

Returns:

  • (String) 


4187
4188
4189
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4187

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:



4192
4193
4194
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4192

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) 


4200
4201
4202
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4200

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) 


4209
4210
4211
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4209

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>) 


4215
4216
4217
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4215

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:



4220
4221
4222
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4220

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) 


4226
4227
4228
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4226

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4233

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