class Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Agent

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

Attributes

advanced_settings[RW]

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` @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3AdvancedSettings]

avatar_uri[RW]

The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](cloud.google.com/dialogflow/ docs/integrations/web-demo) integration. Corresponds to the JSON property `avatarUri` @return [String]

default_language_code[RW]

Required. Immutable. The default language of the agent as a language tag. See [ Language Support](cloud.google.com/dialogflow/cx/docs/reference/ language) 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` @return [String]

description[RW]

The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. Corresponds to the JSON property `description` @return [String]

display_name[RW]

Required. The human-readable name of the agent, unique within the location. Corresponds to the JSON property `displayName` @return [String]

enable_spell_correction[RW]

Indicates if automatic spell correction is enabled in detect intent requests. Corresponds to the JSON property `enableSpellCorrection` @return [Boolean]

enable_spell_correction?[RW]

Indicates if automatic spell correction is enabled in detect intent requests. Corresponds to the JSON property `enableSpellCorrection` @return [Boolean]

enable_stackdriver_logging[RW]

Indicates if stackdriver logging is enabled for the agent. Please use agent. advanced_settings instead. Corresponds to the JSON property `enableStackdriverLogging` @return [Boolean]

enable_stackdriver_logging?[RW]

Indicates if stackdriver logging is enabled for the agent. Please use agent. advanced_settings instead. Corresponds to the JSON property `enableStackdriverLogging` @return [Boolean]

name[RW]

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` @return [String]

security_settings[RW]

Name of the SecuritySettings reference for the agent. Format: `projects// locations//securitySettings/`. Corresponds to the JSON property `securitySettings` @return [String]

speech_to_text_settings[RW]

Settings related to speech recognition. Corresponds to the JSON property `speechToTextSettings` @return [Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SpeechToTextSettings]

start_flow[RW]

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` @return [String]

supported_language_codes[RW]

The list of all languages supported by the agent (except for the ` default_language_code`). Corresponds to the JSON property `supportedLanguageCodes` @return [Array<String>]

time_zone[RW]

Required. The time zone of the agent from the [time zone database](www. iana.org/time-zones), e.g., America/New_York, Europe/Paris. Corresponds to the JSON property `timeZone` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/dialogflow_v3/classes.rb, line 164
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/dialogflow_v3/classes.rb, line 169
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)
  @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