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

Inherits:
Object
  • Object
show all
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, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..

Instance Attribute Summary collapse

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:



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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.



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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.



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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.



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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.



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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.



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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.



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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:



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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.



105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/agent.rb', line 105

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