1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/dialogflow/v2/agent.proto 18 19 package com.google.cloud.dialogflow.v2; 20 21 public interface AgentOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.Agent) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The project of this agent. 31 * Format: `projects/<Project ID>`. 32 * </pre> 33 * 34 * <code> 35 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 36 * </code> 37 * 38 * @return The parent. 39 */ getParent()40 java.lang.String getParent(); 41 /** 42 * 43 * 44 * <pre> 45 * Required. The project of this agent. 46 * Format: `projects/<Project ID>`. 47 * </pre> 48 * 49 * <code> 50 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 51 * </code> 52 * 53 * @return The bytes for parent. 54 */ getParentBytes()55 com.google.protobuf.ByteString getParentBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * Required. The name of this agent. 62 * </pre> 63 * 64 * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 65 * 66 * @return The displayName. 67 */ getDisplayName()68 java.lang.String getDisplayName(); 69 /** 70 * 71 * 72 * <pre> 73 * Required. The name of this agent. 74 * </pre> 75 * 76 * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 77 * 78 * @return The bytes for displayName. 79 */ getDisplayNameBytes()80 com.google.protobuf.ByteString getDisplayNameBytes(); 81 82 /** 83 * 84 * 85 * <pre> 86 * Required. The default language of the agent as a language tag. See 87 * [Language 88 * Support](https://cloud.google.com/dialogflow/docs/reference/language) 89 * for a list of the currently supported language codes. This field cannot be 90 * set by the `Update` method. 91 * </pre> 92 * 93 * <code>string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED];</code> 94 * 95 * @return The defaultLanguageCode. 96 */ getDefaultLanguageCode()97 java.lang.String getDefaultLanguageCode(); 98 /** 99 * 100 * 101 * <pre> 102 * Required. The default language of the agent as a language tag. See 103 * [Language 104 * Support](https://cloud.google.com/dialogflow/docs/reference/language) 105 * for a list of the currently supported language codes. This field cannot be 106 * set by the `Update` method. 107 * </pre> 108 * 109 * <code>string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED];</code> 110 * 111 * @return The bytes for defaultLanguageCode. 112 */ getDefaultLanguageCodeBytes()113 com.google.protobuf.ByteString getDefaultLanguageCodeBytes(); 114 115 /** 116 * 117 * 118 * <pre> 119 * Optional. The list of all languages supported by this agent (except for the 120 * `default_language_code`). 121 * </pre> 122 * 123 * <code>repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL]; 124 * </code> 125 * 126 * @return A list containing the supportedLanguageCodes. 127 */ getSupportedLanguageCodesList()128 java.util.List<java.lang.String> getSupportedLanguageCodesList(); 129 /** 130 * 131 * 132 * <pre> 133 * Optional. The list of all languages supported by this agent (except for the 134 * `default_language_code`). 135 * </pre> 136 * 137 * <code>repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL]; 138 * </code> 139 * 140 * @return The count of supportedLanguageCodes. 141 */ getSupportedLanguageCodesCount()142 int getSupportedLanguageCodesCount(); 143 /** 144 * 145 * 146 * <pre> 147 * Optional. The list of all languages supported by this agent (except for the 148 * `default_language_code`). 149 * </pre> 150 * 151 * <code>repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL]; 152 * </code> 153 * 154 * @param index The index of the element to return. 155 * @return The supportedLanguageCodes at the given index. 156 */ getSupportedLanguageCodes(int index)157 java.lang.String getSupportedLanguageCodes(int index); 158 /** 159 * 160 * 161 * <pre> 162 * Optional. The list of all languages supported by this agent (except for the 163 * `default_language_code`). 164 * </pre> 165 * 166 * <code>repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL]; 167 * </code> 168 * 169 * @param index The index of the value to return. 170 * @return The bytes of the supportedLanguageCodes at the given index. 171 */ getSupportedLanguageCodesBytes(int index)172 com.google.protobuf.ByteString getSupportedLanguageCodesBytes(int index); 173 174 /** 175 * 176 * 177 * <pre> 178 * Required. The time zone of this agent from the 179 * [time zone database](https://www.iana.org/time-zones), e.g., 180 * America/New_York, Europe/Paris. 181 * </pre> 182 * 183 * <code>string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];</code> 184 * 185 * @return The timeZone. 186 */ getTimeZone()187 java.lang.String getTimeZone(); 188 /** 189 * 190 * 191 * <pre> 192 * Required. The time zone of this agent from the 193 * [time zone database](https://www.iana.org/time-zones), e.g., 194 * America/New_York, Europe/Paris. 195 * </pre> 196 * 197 * <code>string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];</code> 198 * 199 * @return The bytes for timeZone. 200 */ getTimeZoneBytes()201 com.google.protobuf.ByteString getTimeZoneBytes(); 202 203 /** 204 * 205 * 206 * <pre> 207 * Optional. The description of this agent. 208 * The maximum length is 500 characters. If exceeded, the request is rejected. 209 * </pre> 210 * 211 * <code>string description = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 212 * 213 * @return The description. 214 */ getDescription()215 java.lang.String getDescription(); 216 /** 217 * 218 * 219 * <pre> 220 * Optional. The description of this agent. 221 * The maximum length is 500 characters. If exceeded, the request is rejected. 222 * </pre> 223 * 224 * <code>string description = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 225 * 226 * @return The bytes for description. 227 */ getDescriptionBytes()228 com.google.protobuf.ByteString getDescriptionBytes(); 229 230 /** 231 * 232 * 233 * <pre> 234 * Optional. The URI of the agent's avatar. 235 * Avatars are used throughout the Dialogflow console and in the self-hosted 236 * [Web 237 * Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) 238 * integration. 239 * </pre> 240 * 241 * <code>string avatar_uri = 7 [(.google.api.field_behavior) = OPTIONAL];</code> 242 * 243 * @return The avatarUri. 244 */ getAvatarUri()245 java.lang.String getAvatarUri(); 246 /** 247 * 248 * 249 * <pre> 250 * Optional. The URI of the agent's avatar. 251 * Avatars are used throughout the Dialogflow console and in the self-hosted 252 * [Web 253 * Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) 254 * integration. 255 * </pre> 256 * 257 * <code>string avatar_uri = 7 [(.google.api.field_behavior) = OPTIONAL];</code> 258 * 259 * @return The bytes for avatarUri. 260 */ getAvatarUriBytes()261 com.google.protobuf.ByteString getAvatarUriBytes(); 262 263 /** 264 * 265 * 266 * <pre> 267 * Optional. Determines whether this agent should log conversation queries. 268 * </pre> 269 * 270 * <code>bool enable_logging = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 271 * 272 * @return The enableLogging. 273 */ getEnableLogging()274 boolean getEnableLogging(); 275 276 /** 277 * 278 * 279 * <pre> 280 * Optional. Determines how intents are detected from user queries. 281 * </pre> 282 * 283 * <code> 284 * .google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL]; 285 * </code> 286 * 287 * @deprecated google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See 288 * google/cloud/dialogflow/v2/agent.proto;l=354 289 * @return The enum numeric value on the wire for matchMode. 290 */ 291 @java.lang.Deprecated getMatchModeValue()292 int getMatchModeValue(); 293 /** 294 * 295 * 296 * <pre> 297 * Optional. Determines how intents are detected from user queries. 298 * </pre> 299 * 300 * <code> 301 * .google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL]; 302 * </code> 303 * 304 * @deprecated google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See 305 * google/cloud/dialogflow/v2/agent.proto;l=354 306 * @return The matchMode. 307 */ 308 @java.lang.Deprecated getMatchMode()309 com.google.cloud.dialogflow.v2.Agent.MatchMode getMatchMode(); 310 311 /** 312 * 313 * 314 * <pre> 315 * Optional. To filter out false positive results and still get variety in 316 * matched natural language inputs for your agent, you can tune the machine 317 * learning classification threshold. If the returned score value is less than 318 * the threshold value, then a fallback intent will be triggered or, if there 319 * are no fallback intents defined, no intent will be triggered. The score 320 * values range from 0.0 (completely uncertain) to 1.0 (completely certain). 321 * If set to 0.0, the default of 0.3 is used. 322 * </pre> 323 * 324 * <code>float classification_threshold = 10 [(.google.api.field_behavior) = OPTIONAL];</code> 325 * 326 * @return The classificationThreshold. 327 */ getClassificationThreshold()328 float getClassificationThreshold(); 329 330 /** 331 * 332 * 333 * <pre> 334 * Optional. API version displayed in Dialogflow console. If not specified, 335 * V2 API is assumed. Clients are free to query different service endpoints 336 * for different API versions. However, bots connectors and webhook calls will 337 * follow the specified API version. 338 * </pre> 339 * 340 * <code> 341 * .google.cloud.dialogflow.v2.Agent.ApiVersion api_version = 14 [(.google.api.field_behavior) = OPTIONAL]; 342 * </code> 343 * 344 * @return The enum numeric value on the wire for apiVersion. 345 */ getApiVersionValue()346 int getApiVersionValue(); 347 /** 348 * 349 * 350 * <pre> 351 * Optional. API version displayed in Dialogflow console. If not specified, 352 * V2 API is assumed. Clients are free to query different service endpoints 353 * for different API versions. However, bots connectors and webhook calls will 354 * follow the specified API version. 355 * </pre> 356 * 357 * <code> 358 * .google.cloud.dialogflow.v2.Agent.ApiVersion api_version = 14 [(.google.api.field_behavior) = OPTIONAL]; 359 * </code> 360 * 361 * @return The apiVersion. 362 */ getApiVersion()363 com.google.cloud.dialogflow.v2.Agent.ApiVersion getApiVersion(); 364 365 /** 366 * 367 * 368 * <pre> 369 * Optional. The agent tier. If not specified, TIER_STANDARD is assumed. 370 * </pre> 371 * 372 * <code> 373 * .google.cloud.dialogflow.v2.Agent.Tier tier = 15 [(.google.api.field_behavior) = OPTIONAL]; 374 * </code> 375 * 376 * @return The enum numeric value on the wire for tier. 377 */ getTierValue()378 int getTierValue(); 379 /** 380 * 381 * 382 * <pre> 383 * Optional. The agent tier. If not specified, TIER_STANDARD is assumed. 384 * </pre> 385 * 386 * <code> 387 * .google.cloud.dialogflow.v2.Agent.Tier tier = 15 [(.google.api.field_behavior) = OPTIONAL]; 388 * </code> 389 * 390 * @return The tier. 391 */ getTier()392 com.google.cloud.dialogflow.v2.Agent.Tier getTier(); 393 } 394