Skip to content

googleDialogflowEntityType

Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries.

To get more information about EntityType, see:

Example Usage - Dialogflow Entity Type Basic

/*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.*/
const googleDialogflowAgentBasicAgent =
  new google.dialogflowAgent.DialogflowAgent(this, "basic_agent", {
    default_language_code: "en",
    display_name: "example_agent",
    time_zone: "America/New_York",
  });
new google.dialogflowEntityType.DialogflowEntityType(
  this,
  "basic_entity_type",
  {
    depends_on: [`\${${googleDialogflowAgentBasicAgent.fqn}}`],
    display_name: "",
    entities: [
      {
        synonyms: ["synonym1", "synonym2"],
        value: "value1",
      },
      {
        synonyms: ["synonym3", "synonym4"],
        value: "value2",
      },
    ],
    kind: "KIND_MAP",
  }
);

Argument Reference

The following arguments are supported:

  • displayName - (Required) The name of this entity type to be displayed on the console.

  • kind - (Required) Indicates the kind of entity type.

    • KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value.
    • KIND_LIST: List entity types contain a set of entries that do not map to reference 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 kindMap, kindList, and kindRegexp.

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

  • entities - (Optional) The collection of entity entries associated with the entity type. Structure is documented below.

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

The entities block supports:

  • value - (Required) 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 reference 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 - (Required) 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.

Attributes Reference

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

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

  • name - The unique identifier of the entity type. Format: projects//agent/entityTypes/.

Timeouts

This resource provides the following Timeouts configuration options:

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

Import

EntityType can be imported using any of these accepted formats:

$ terraform import google_dialogflow_entity_type.default {{name}}

User Project Overrides

This resource supports User Project Overrides.