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, 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.



3099
3100
3101
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3099

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. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Corresponds to the JSON property advancedSettings

Returns:



3014
3015
3016
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3014

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

Returns:

  • (String) 


3021
3022
3023
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3021

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) 


3029
3030
3031
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3029

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) 


3035
3036
3037
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3035

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) 


3040
3041
3042
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3040

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

Returns:

  • (Boolean) 


3045
3046
3047
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3045

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) 


3052
3053
3054
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3052

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

Returns:

  • (Boolean) 


3059
3060
3061
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3059

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) 


3067
3068
3069
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3067

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

Returns:

  • (String) 


3073
3074
3075
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3073

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:



3078
3079
3080
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3078

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) 


3085
3086
3087
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3085

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


3091
3092
3093
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3091

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


3097
3098
3099
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3097

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3104

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