Package com.google.cloud.dialogflow.v2

Interface AgentOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Agent, Agent.Builder
@Generated public interface AgentOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getParent

      String getParent()
       Required. The project of this agent.
 Format: `projects/<Project ID>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The project of this agent.
 Format: `projects/<Project ID>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getDisplayName

      String getDisplayName()
       Required. The name of this agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The name of this agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.

    • getDefaultLanguageCode

      String getDefaultLanguageCode()
       Required. The default language of the agent as a language tag. See
 [Language
 Support](https://cloud.google.com/dialogflow/docs/reference/language)
 for a list of the currently supported language codes. This field cannot be
 set by the `Update` method.
      string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The defaultLanguageCode.

    • getDefaultLanguageCodeBytes

      com.google.protobuf.ByteString getDefaultLanguageCodeBytes()
       Required. The default language of the agent as a language tag. See
 [Language
 Support](https://cloud.google.com/dialogflow/docs/reference/language)
 for a list of the currently supported language codes. This field cannot be
 set by the `Update` method.
      string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for defaultLanguageCode.

    • getSupportedLanguageCodesList

      List<String> getSupportedLanguageCodesList()
       Optional. The list of all languages supported by this agent (except for the
 `default_language_code`).
      repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the supportedLanguageCodes.

    • getSupportedLanguageCodesCount

      int getSupportedLanguageCodesCount()
       Optional. The list of all languages supported by this agent (except for the
 `default_language_code`).
      repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of supportedLanguageCodes.

    • getSupportedLanguageCodes

      String getSupportedLanguageCodes(int index)
       Optional. The list of all languages supported by this agent (except for the
 `default_language_code`).
      repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The supportedLanguageCodes at the given index.

    • getSupportedLanguageCodesBytes

      com.google.protobuf.ByteString getSupportedLanguageCodesBytes(int index)
       Optional. The list of all languages supported by this agent (except for the
 `default_language_code`).
      repeated string supported_language_codes = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the supportedLanguageCodes at the given index.

    • getTimeZone

      String getTimeZone()
       Required. The time zone of this agent from the
 [time zone database](https://www.iana.org/time-zones), e.g.,
 America/New_York, Europe/Paris.
      string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The timeZone.

    • getTimeZoneBytes

      com.google.protobuf.ByteString getTimeZoneBytes()
       Required. The time zone of this agent from the
 [time zone database](https://www.iana.org/time-zones), e.g.,
 America/New_York, Europe/Paris.
      string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for timeZone.

    • getDescription

      String getDescription()
       Optional. The description of this agent.
 The maximum length is 500 characters. If exceeded, the request is rejected.
      string description = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. The description of this agent.
 The maximum length is 500 characters. If exceeded, the request is rejected.
      string description = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getAvatarUri

      String getAvatarUri()
       Optional. The URI of the agent's avatar.
 Avatars are used throughout the Dialogflow console and in the self-hosted
 [Web
 Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
 integration.
      string avatar_uri = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The avatarUri.

    • getAvatarUriBytes

      com.google.protobuf.ByteString getAvatarUriBytes()
       Optional. The URI of the agent's avatar.
 Avatars are used throughout the Dialogflow console and in the self-hosted
 [Web
 Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
 integration.
      string avatar_uri = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for avatarUri.

    • getEnableLogging

      boolean getEnableLogging()
       Optional. Determines whether this agent should log conversation queries.
      bool enable_logging = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enableLogging.

    • getMatchModeValue

      @Deprecated int getMatchModeValue()
      Deprecated.
      google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See google/cloud/dialogflow/v2/agent.proto;l=353
       Optional. Determines how intents are detected from user queries.
      .google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for matchMode.

    • getMatchMode

      @Deprecated Agent.MatchMode getMatchMode()
      Deprecated.
      google.cloud.dialogflow.v2.Agent.match_mode is deprecated. See google/cloud/dialogflow/v2/agent.proto;l=353
       Optional. Determines how intents are detected from user queries.
      .google.cloud.dialogflow.v2.Agent.MatchMode match_mode = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The matchMode.

    • getClassificationThreshold

      float getClassificationThreshold()
       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.
      float classification_threshold = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The classificationThreshold.

    • getApiVersionValue

      int getApiVersionValue()
       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.
      .google.cloud.dialogflow.v2.Agent.ApiVersion api_version = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for apiVersion.

    • getApiVersion

      Agent.ApiVersion getApiVersion()
       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.
      .google.cloud.dialogflow.v2.Agent.ApiVersion api_version = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The apiVersion.

    • getTierValue

      int getTierValue()
       Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
      .google.cloud.dialogflow.v2.Agent.Tier tier = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for tier.

    • getTier

      Agent.Tier getTier()
       Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
      .google.cloud.dialogflow.v2.Agent.Tier tier = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The tier.