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.



2461
2462
2463
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2461

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) 


2397
2398
2399
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2397

def avatar_uri
  @avatar_uri
end

#default_language_code ⇒ String

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) 


2405
2406
2407
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2405

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) 


2411
2412
2413
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2411

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) 


2416
2417
2418
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2416

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) 


2421
2422
2423
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2421

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) 


2427
2428
2429
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2427

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) 


2435
2436
2437
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2435

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) 


2441
2442
2443
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2441

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:



2446
2447
2448
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2446

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) 


2453
2454
2455
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2453

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


2459
2460
2461
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2459

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 2466

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