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



108
109
110
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 108

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

Instance Attribute Details

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


38
39
40
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 38

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) 


46
47
48
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 46

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) 


52
53
54
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 52

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) 


57
58
59
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 57

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) 


62
63
64
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 62

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. Corresponds to the JSON property enableStackdriverLogging

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 68

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


76
77
78
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 76

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) 


82
83
84
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 82

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:



87
88
89
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 87

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) 


94
95
96
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 94

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


100
101
102
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 100

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) 


106
107
108
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 106

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 113

def update!(**args)
  @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)
  @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