Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2beta1/classes.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb

Overview

A Dialogflow agent is a virtual agent that handles conversations with your end- users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the Agent guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Agent

Returns a new instance of GoogleCloudDialogflowV2beta1Agent.



9177
9178
9179
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9177

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_version ⇒ String

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. Corresponds to the JSON property apiVersion

Returns:

  • (String) 


9104
9105
9106
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9104

def api_version
  @api_version
end

#avatar_uri ⇒ String

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


9111
9112
9113
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9111

def avatar_uri
  @avatar_uri
end

#classification_threshold ⇒ 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. Corresponds to the JSON property classificationThreshold

Returns:

  • (Float) 


9122
9123
9124
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9122

def classification_threshold
  @classification_threshold
end

#default_language_code ⇒ 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. Corresponds to the JSON property defaultLanguageCode

Returns:

  • (String) 


9130
9131
9132
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9130

def default_language_code
  @default_language_code
end

#description ⇒ String

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

Returns:

  • (String) 


9136
9137
9138
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9136

def description
  @description
end

#display_name ⇒ String

Required. The name of this agent. Corresponds to the JSON property displayName

Returns:

  • (String) 


9141
9142
9143
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9141

def display_name
  @display_name
end

#enable_logging ⇒ Boolean Also known as: enable_logging?

Optional. Determines whether this agent should log conversation queries. Corresponds to the JSON property enableLogging

Returns:

  • (Boolean) 


9146
9147
9148
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9146

def enable_logging
  @enable_logging
end

#match_mode ⇒ String

Optional. Determines how intents are detected from user queries. Corresponds to the JSON property matchMode

Returns:

  • (String) 


9152
9153
9154
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9152

def match_mode
  @match_mode
end

#parent ⇒ String

Required. The project of this agent. Format: projects/ or projects// locations/ Corresponds to the JSON property parent

Returns:

  • (String) 


9158
9159
9160
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9158

def parent
  @parent
end

#supported_language_codes ⇒ Array<String>

Optional. The list of all languages supported by this agent (except for the default_language_code). Corresponds to the JSON property supportedLanguageCodes

Returns:

  • (Array<String>) 


9164
9165
9166
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9164

def supported_language_codes
  @supported_language_codes
end

#tier ⇒ String

Optional. The agent tier. If not specified, TIER_STANDARD is assumed. Corresponds to the JSON property tier

Returns:

  • (String) 


9169
9170
9171
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9169

def tier
  @tier
end

#time_zone ⇒ String

Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris. Corresponds to the JSON property timeZone

Returns:

  • (String) 


9175
9176
9177
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9175

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 9182

def update!(**args)
  @api_version = args[:api_version] if args.key?(:api_version)
  @avatar_uri = args[:avatar_uri] if args.key?(:avatar_uri)
  @classification_threshold = args[:classification_threshold] if args.key?(:classification_threshold)
  @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_logging = args[:enable_logging] if args.key?(:enable_logging)
  @match_mode = args[:match_mode] if args.key?(:match_mode)
  @parent = args[:parent] if args.key?(:parent)
  @supported_language_codes = args[:supported_language_codes] if args.key?(:supported_language_codes)
  @tier = args[:tier] if args.key?(:tier)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
end