Class: Google::Cloud::Dialogflow::CX::V3::Agent

Inherits:

Object

• Object
• Google::Cloud::Dialogflow::CX::V3::Agent

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dialogflow/cx/v3/agent.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][google.cloud.dialogflow.cx.v3.EntityType], Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..

Instance Attribute Summary

• #advanced_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

  Hierarchical advanced settings for this agent.

• #avatar_uri ⇒ ::String

  The URI of the agent's avatar.

• #default_language_code ⇒ ::String

  Required.

• #description ⇒ ::String

  The description of the agent.

• #display_name ⇒ ::String

  Required.

• #enable_spell_correction ⇒ ::Boolean

  Indicates if automatic spell correction is enabled in detect intent requests.

• #enable_stackdriver_logging ⇒ ::Boolean

  Indicates if stackdriver logging is enabled for the agent.

• #locked ⇒ ::Boolean

  Indicates whether the agent is locked for changes.

• #name ⇒ ::String

  The unique identifier of the agent.

• #security_settings ⇒ ::String

  Name of the SecuritySettings reference for the agent.

• #speech_to_text_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::SpeechToTextSettings

  Speech recognition related settings.

• #start_flow ⇒ ::String

  Immutable.

• #supported_language_codes ⇒ ::Array<::String>

  The list of all languages supported by the agent (except for the default_language_code).

• #text_to_speech_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings

  Settings on instructing the speech synthesizer on how to generate the output audio content.

• #time_zone ⇒ ::String

  Required.

Instance Attribute Details

#advanced_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings

Returns Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

Returns:

• (::Google::Cloud::Dialogflow::CX::V3::AdvancedSettings) —

  Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#avatar_uri ⇒ ::String

Returns The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

Returns:

• (::String) —

  The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#default_language_code ⇒ ::String

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

Returns:

• (::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.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

Returns:

• (::String) —

  The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns Required. The human-readable name of the agent, unique within the location.

Returns:

• (::String) —

  Required. The human-readable name of the agent, unique within the location.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#enable_spell_correction ⇒ ::Boolean

Returns Indicates if automatic spell correction is enabled in detect intent requests.

Returns:

• (::Boolean) —

  Indicates if automatic spell correction is enabled in detect intent requests.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#enable_stackdriver_logging ⇒ ::Boolean

Returns Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

Returns:

• (::Boolean) —

  Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#locked ⇒ ::Boolean

Returns Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

Returns:

• (::Boolean) —

  Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for [RestoreAgent][].

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Returns:

• (::String) —

  The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#security_settings ⇒ ::String

Returns Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

Returns:

• (::String) —

  Name of the SecuritySettings reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#speech_to_text_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::SpeechToTextSettings

Returns Speech recognition related settings.

Returns:

• (::Google::Cloud::Dialogflow::CX::V3::SpeechToTextSettings) —

  Speech recognition related settings.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#start_flow ⇒ ::String

Returns 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Returns:

• (::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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#supported_language_codes ⇒ ::Array<::String>

Returns The list of all languages supported by the agent (except for the default_language_code).

Returns:

• (::Array<::String>) —

  The list of all languages supported by the agent (except for the default_language_code).

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text_to_speech_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings

Returns Settings on instructing the speech synthesizer on how to generate the output audio content.

Returns:

• (::Google::Cloud::Dialogflow::CX::V3::TextToSpeechSettings) —

  Settings on instructing the speech synthesizer on how to generate the output audio content.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#time_zone ⇒ ::String

Returns Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

Returns:

• (::String) —

  Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 123

class Agent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end