Package com.hashicorp.cdktf.providers.google.dialogflow_agent

Interface DialogflowAgentConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    DialogflowAgentConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:20.913Z")
@Stability(Stable)
public interface DialogflowAgentConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getDefaultLanguageCode

        @Stability(Stable)
@NotNull
String getDefaultLanguageCode()
        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 updated after creation. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#default_language_code DialogflowAgent#default_language_code}

      • getDisplayName

        @Stability(Stable)
@NotNull
String getDisplayName()
        The name of this agent.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#display_name DialogflowAgent#display_name}

      • getTimeZone

        @Stability(Stable)
@NotNull
String getTimeZone()
        The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#time_zone DialogflowAgent#time_zone}

      • getApiVersion

        @Stability(Stable)
@Nullable
default String getApiVersion()
        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. * API_VERSION_V1: Legacy V1 API. * API_VERSION_V2: V2 API. * API_VERSION_V2_BETA_1: V2beta1 API. Possible values: ["API_VERSION_V1", "API_VERSION_V2", "API_VERSION_V2_BETA_1"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#api_version DialogflowAgent#api_version}

      • getAvatarUri

        @Stability(Stable)
@Nullable
default String getAvatarUri()
        The URI of the agent's avatar, which are used throughout the Dialogflow console.

        When an image URL is entered into this field, the Dialogflow will save the image in the backend. The address of the backend image returned from the API will be shown in the [avatarUriBackend] field. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#avatar_uri DialogflowAgent#avatar_uri}

      • getClassificationThreshold

        @Stability(Stable)
@Nullable
default Number getClassificationThreshold()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#classification_threshold DialogflowAgent#classification_threshold}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#description DialogflowAgent#description}

      • getEnableLogging

        @Stability(Stable)
@Nullable
default Object getEnableLogging()
        Determines whether this agent should log conversation queries.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#enable_logging DialogflowAgent#enable_logging}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#id DialogflowAgent#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getMatchMode

        @Stability(Stable)
@Nullable
default String getMatchMode()
        Determines how intents are detected from user queries.

        • MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.
        • MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones using

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#project DialogflowAgent#project}.

      • getSupportedLanguageCodes

        @Stability(Stable)
@Nullable
default List<String> getSupportedLanguageCodes()
        The list of all languages supported by this agent (except for the defaultLanguageCode).

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#supported_language_codes DialogflowAgent#supported_language_codes}

      • getTier

        @Stability(Stable)
@Nullable
default String getTier()
        The agent tier.

        If not specified, TIER_STANDARD is assumed. * TIER_STANDARD: Standard tier. * TIER_ENTERPRISE: Enterprise tier (Essentials). * TIER_ENTERPRISE_PLUS: Enterprise tier (Plus). NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between the Terraform state and Dialogflow if the agent tier is changed outside of Terraform. Possible values: ["TIER_STANDARD", "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#tier DialogflowAgent#tier}

      • getTimeouts

        @Stability(Stable)
@Nullable
default DialogflowAgentTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#timeouts DialogflowAgent#timeouts}