Class: Google::Cloud::Dialogflow::V2::Agent

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb

Overview

Represents a conversational agent.

Defined Under Namespace

Modules: ApiVersion, MatchMode, Tier

Instance Attribute Summary collapse

Instance Attribute Details

#api_version ⇒ Google::Cloud::Dialogflow::V2::Agent::ApiVersion

Returns Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.

Returns:

  • (Google::Cloud::Dialogflow::V2::Agent::ApiVersion) —

    Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#avatar_uri ⇒ String

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

Returns:

  • (String) —

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#classification_threshold ⇒ Float

Returns Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.

Returns:

  • (Float) —

    Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#default_language_code ⇒ String

Returns Required. 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 Update method.

Returns:

  • (String) —

    Required. 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 Update method.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#description ⇒ String

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

Returns:

  • (String) —

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#display_name ⇒ String

Returns Required. The name of this agent.

Returns:

  • (String) —

    Required. The name of this agent.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#enable_logging ⇒ true, false

Returns Optional. Determines whether this agent should log conversation queries.

Returns:

  • (true, false) —

    Optional. Determines whether this agent should log conversation queries.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#match_mode ⇒ Google::Cloud::Dialogflow::V2::Agent::MatchMode

Returns Optional. Determines how intents are detected from user queries.

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#parent ⇒ String

Returns Required. The project of this agent. Format: projects/<Project ID>.

Returns:

  • (String) —

    Required. The project of this agent. Format: projects/<Project ID>.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#supported_language_codes ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#tier ⇒ Google::Cloud::Dialogflow::V2::Agent::Tier

Returns Optional. The agent tier. If not specified, TIER_STANDARD is assumed.

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end

#time_zone ⇒ String

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

Returns:

  • (String) —

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dialogflow/v2/doc/google/cloud/dialogflow/v2/agent.rb', line 79

class Agent
  # API version for the agent.
  module ApiVersion
    # Not specified.
    API_VERSION_UNSPECIFIED = 0

    # Legacy V1 API.
    API_VERSION_V1 = 1

    # V2 API.
    API_VERSION_V2 = 2

    # V2beta1 API.
    API_VERSION_V2_BETA_1 = 3
  end

  # Match mode determines how intents are detected from user queries.
  module MatchMode
    # Not specified.
    MATCH_MODE_UNSPECIFIED = 0

    # Best for agents with a small number of examples in intents and/or wide
    # use of templates syntax and composite entities.
    MATCH_MODE_HYBRID = 1

    # Can be used for agents with a large number of examples in intents,
    # especially the ones using @sys.any or very large developer entities.
    MATCH_MODE_ML_ONLY = 2
  end

  # Represents the agent tier.
  module Tier
    # Not specified. This value should never be used.
    TIER_UNSPECIFIED = 0

    # Standard tier.
    TIER_STANDARD = 1

    # Enterprise tier (Essentials).
    TIER_ENTERPRISE = 2

    # Enterprise tier (Plus).
    TIER_ENTERPRISE_PLUS = 3
  end
end