Google Dialogflow CX Entity Type

This page shows how to write Terraform for Dialogflow CX Entity Type and write them securely.

google_dialogflow_cx_entity_type (Terraform)

The Entity Type in Dialogflow CX can be configured in Terraform with the resource name google_dialogflow_cx_entity_type. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).


The following arguments are supported:

  • display_name - (Required) The human-readable name of the entity type, unique within the agent.

  • kind - (Required) Indicates whether the entity type can be automatically expanded.

    • KIND_MAP: Map entity types allow mapping of a group of synonyms to a canonical value.
    • KIND_LIST: List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).
    • KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values are KIND_MAP, KIND_LIST, and KIND_REGEXP.
  • entities - (Required) The collection of entity entries associated with the entity type. Structure is documented below.

The entities block supports:

  • value - (Optional) The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions. For KIND_MAP entity types: A canonical value to be used in place of synonyms. For KIND_LIST entity types: A string that can contain references to other entity types (with or without aliases).

  • synonyms - (Optional) A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions. For KIND_LIST entity types: This collection must contain exactly one synonym equal to value.

  • auto_expansion_mode - (Optional) Represents kinds of entities.

    • AUTO_EXPANSION_MODE_UNSPECIFIED: Auto expansion disabled for the entity.
    • AUTO_EXPANSION_MODE_DEFAULT: Allows an agent to recognize values that have not been explicitly listed in the entity. Possible values are AUTO_EXPANSION_MODE_DEFAULT and AUTO_EXPANSION_MODE_UNSPECIFIED.
  • excluded_phrases - (Optional) Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant(an adjective), you might consider adding giants(a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. Structure is documented below.

  • enable_fuzzy_extraction - (Optional) Enables fuzzy entity extraction during classification.

  • redact - (Optional) Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

  • parent - (Optional) The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

  • language_code - (Optional) The language of the following fields in entityType: EntityType.entities.value EntityType.entities.synonyms EntityType.excluded_phrases.value If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

The excluded_phrases block supports:

  • value - (Optional) The word or phrase to be excluded.

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

  • id - an identifier for the resource with format [[parent]]/entityTypes/[[name]]

  • name - The unique identifier of the entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

Explanation in Terraform Registry

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application. To get more information about EntityType, see:

Frequently asked questions

What is Google Dialogflow CX Entity Type?

Google Dialogflow CX Entity Type is a resource for Dialogflow CX of Google Cloud Platform. Settings can be wrote in Terraform.


Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.