Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dialogflow_v2/classes.rb,
generated/google/apis/dialogflow_v2/representations.rb,
generated/google/apis/dialogflow_v2/representations.rb
Overview
Represents a conversational agent.
Instance Attribute Summary collapse
-
#api_version ⇒ String
Optional.
-
#avatar_uri ⇒ String
Optional.
-
#classification_threshold ⇒ Float
Optional.
-
#default_language_code ⇒ String
Required.
-
#description ⇒ String
Optional.
-
#display_name ⇒ String
Required.
-
#enable_logging ⇒ Boolean
(also: #enable_logging?)
Optional.
-
#match_mode ⇒ String
Optional.
-
#parent ⇒ String
Required.
-
#supported_language_codes ⇒ Array<String>
Optional.
-
#tier ⇒ String
Optional.
-
#time_zone ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2Agent
constructor
A new instance of GoogleCloudDialogflowV2Agent.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2Agent
Returns a new instance of GoogleCloudDialogflowV2Agent.
112 113 114 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 112 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
35 36 37 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 35 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
44 45 46 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 44 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
55 56 57 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 55 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
64 65 66 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 64 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
70 71 72 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 70 def description @description end |
#display_name ⇒ String
Required. The name of this agent.
Corresponds to the JSON property displayName
75 76 77 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 75 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
80 81 82 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 80 def enable_logging @enable_logging end |
#match_mode ⇒ String
Optional. Determines how intents are detected from user queries.
Corresponds to the JSON property matchMode
86 87 88 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 86 def match_mode @match_mode end |
#parent ⇒ String
Required. The project of this agent.
Format: projects/<Project ID>
.
Corresponds to the JSON property parent
92 93 94 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 92 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
98 99 100 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 98 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
103 104 105 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 103 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
110 111 112 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 110 def time_zone @time_zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 117 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 |