Skip to content

googleDialogflowAgent

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.

To get more information about Agent, see:

Open in Cloud Shell

Example Usage - Dialogflow Agent Full

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.dialogflowAgent.DialogflowAgent(this, "full_agent", {
  api_version: "API_VERSION_V2_BETA_1",
  avatar_uri:
    "https://cloud.google.com/_static/images/cloud/icons/favicons/onecloud/super_cloud.png",
  classification_threshold: 0.3,
  default_language_code: "en",
  description: "Example description.",
  display_name: "dialogflow-agent",
  enable_logging: true,
  match_mode: "MATCH_MODE_ML_ONLY",
  supported_language_codes: ["fr", "de", "es"],
  tier: "TIER_STANDARD",
  time_zone: "America/New_York",
});

Argument Reference

The following arguments are supported:

  • displayName - (Required) The name of this agent.

  • defaultLanguageCode - (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 updated after creation.

  • timeZone - (Required) The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.

  • supportedLanguageCodes - (Optional) The list of all languages supported by this agent (except for the defaultLanguageCode).

  • description - (Optional) The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.

  • avatarUri - (Optional) 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.

  • enableLogging - (Optional) Determines whether this agent should log conversation queries.

  • matchMode - (Optional) 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 @sys.any or very large developer entities. Possible values are matchModeHybrid and matchModeMlOnly.

  • classificationThreshold - (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.

  • apiVersion - (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.

    • API_VERSION_V1: Legacy V1 API.
    • API_VERSION_V2: V2 API.
    • API_VERSION_V2_BETA_1: V2beta1 API. Possible values are apiVersionV1, apiVersionV2, and apiVersionV2Beta1.

  • tier - (Optional) 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 are tierStandard, tierEnterprise, and tierEnterprisePlus.

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format {{project}}

  • avatarUriBackend - The URI of the agent's avatar as returned from the API. Output only. To provide an image URL for the agent avatar, the [avatarUri] field can be used.

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 40 minutes.
  • update - Default is 40 minutes.
  • delete - Default is 20 minutes.

Import

Agent can be imported using any of these accepted formats:

$ terraform import google_dialogflow_agent.default {{project}}

User Project Overrides

This resource supports User Project Overrides.