1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v2
  6. EntityType

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.dialogflow/v2.EntityType

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Creates an entity type in the specified agent. Note: You should always train an agent prior to sending it queries. See the training documentation. Auto-naming is currently not supported for this resource.

    Create EntityType Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EntityType(name: string, args: EntityTypeArgs, opts?: CustomResourceOptions);
    @overload
    def EntityType(resource_name: str,
                   args: EntityTypeArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def EntityType(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   display_name: Optional[str] = None,
                   kind: Optional[EntityTypeKind] = None,
                   auto_expansion_mode: Optional[EntityTypeAutoExpansionMode] = None,
                   enable_fuzzy_extraction: Optional[bool] = None,
                   entities: Optional[Sequence[GoogleCloudDialogflowV2EntityTypeEntityArgs]] = None,
                   language_code: Optional[str] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   project: Optional[str] = None)
    func NewEntityType(ctx *Context, name string, args EntityTypeArgs, opts ...ResourceOption) (*EntityType, error)
    public EntityType(string name, EntityTypeArgs args, CustomResourceOptions? opts = null)
    public EntityType(String name, EntityTypeArgs args)
    public EntityType(String name, EntityTypeArgs args, CustomResourceOptions options)
    
    type: google-native:dialogflow/v2:EntityType
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EntityTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EntityTypeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EntityTypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntityTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntityTypeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleentityTypeResourceResourceFromDialogflowv2 = new GoogleNative.Dialogflow.V2.EntityType("exampleentityTypeResourceResourceFromDialogflowv2", new()
    {
        DisplayName = "string",
        Kind = GoogleNative.Dialogflow.V2.EntityTypeKind.KindUnspecified,
        AutoExpansionMode = GoogleNative.Dialogflow.V2.EntityTypeAutoExpansionMode.AutoExpansionModeUnspecified,
        EnableFuzzyExtraction = false,
        Entities = new[]
        {
            new GoogleNative.Dialogflow.V2.Inputs.GoogleCloudDialogflowV2EntityTypeEntityArgs
            {
                Synonyms = new[]
                {
                    "string",
                },
                Value = "string",
            },
        },
        LanguageCode = "string",
        Location = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := dialogflow.NewEntityType(ctx, "exampleentityTypeResourceResourceFromDialogflowv2", &dialogflow.EntityTypeArgs{
    DisplayName: pulumi.String("string"),
    Kind: dialogflow.EntityTypeKindKindUnspecified,
    AutoExpansionMode: dialogflow.EntityTypeAutoExpansionModeAutoExpansionModeUnspecified,
    EnableFuzzyExtraction: pulumi.Bool(false),
    Entities: dialogflow.GoogleCloudDialogflowV2EntityTypeEntityArray{
    &dialogflow.GoogleCloudDialogflowV2EntityTypeEntityArgs{
    Synonyms: pulumi.StringArray{
    pulumi.String("string"),
    },
    Value: pulumi.String("string"),
    },
    },
    LanguageCode: pulumi.String("string"),
    Location: pulumi.String("string"),
    Name: pulumi.String("string"),
    Project: pulumi.String("string"),
    })
    
    var exampleentityTypeResourceResourceFromDialogflowv2 = new EntityType("exampleentityTypeResourceResourceFromDialogflowv2", EntityTypeArgs.builder()
        .displayName("string")
        .kind("KIND_UNSPECIFIED")
        .autoExpansionMode("AUTO_EXPANSION_MODE_UNSPECIFIED")
        .enableFuzzyExtraction(false)
        .entities(GoogleCloudDialogflowV2EntityTypeEntityArgs.builder()
            .synonyms("string")
            .value("string")
            .build())
        .languageCode("string")
        .location("string")
        .name("string")
        .project("string")
        .build());
    
    exampleentity_type_resource_resource_from_dialogflowv2 = google_native.dialogflow.v2.EntityType("exampleentityTypeResourceResourceFromDialogflowv2",
        display_name="string",
        kind=google_native.dialogflow.v2.EntityTypeKind.KIND_UNSPECIFIED,
        auto_expansion_mode=google_native.dialogflow.v2.EntityTypeAutoExpansionMode.AUTO_EXPANSION_MODE_UNSPECIFIED,
        enable_fuzzy_extraction=False,
        entities=[google_native.dialogflow.v2.GoogleCloudDialogflowV2EntityTypeEntityArgs(
            synonyms=["string"],
            value="string",
        )],
        language_code="string",
        location="string",
        name="string",
        project="string")
    
    const exampleentityTypeResourceResourceFromDialogflowv2 = new google_native.dialogflow.v2.EntityType("exampleentityTypeResourceResourceFromDialogflowv2", {
        displayName: "string",
        kind: google_native.dialogflow.v2.EntityTypeKind.KindUnspecified,
        autoExpansionMode: google_native.dialogflow.v2.EntityTypeAutoExpansionMode.AutoExpansionModeUnspecified,
        enableFuzzyExtraction: false,
        entities: [{
            synonyms: ["string"],
            value: "string",
        }],
        languageCode: "string",
        location: "string",
        name: "string",
        project: "string",
    });
    
    type: google-native:dialogflow/v2:EntityType
    properties:
        autoExpansionMode: AUTO_EXPANSION_MODE_UNSPECIFIED
        displayName: string
        enableFuzzyExtraction: false
        entities:
            - synonyms:
                - string
              value: string
        kind: KIND_UNSPECIFIED
        languageCode: string
        location: string
        name: string
        project: string
    

    EntityType Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EntityType resource accepts the following input properties:

    DisplayName string
    The name of the entity type.
    Kind Pulumi.GoogleNative.Dialogflow.V2.EntityTypeKind
    Indicates the kind of entity type.
    AutoExpansionMode Pulumi.GoogleNative.Dialogflow.V2.EntityTypeAutoExpansionMode
    Optional. Indicates whether the entity type can be automatically expanded.
    EnableFuzzyExtraction bool
    Optional. Enables fuzzy entity extraction during classification.
    Entities List<Pulumi.GoogleNative.Dialogflow.V2.Inputs.GoogleCloudDialogflowV2EntityTypeEntity>
    Optional. The collection of entity entries associated with the entity type.
    LanguageCode string
    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    Location string
    Name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.
    Project string
    DisplayName string
    The name of the entity type.
    Kind EntityTypeKind
    Indicates the kind of entity type.
    AutoExpansionMode EntityTypeAutoExpansionMode
    Optional. Indicates whether the entity type can be automatically expanded.
    EnableFuzzyExtraction bool
    Optional. Enables fuzzy entity extraction during classification.
    Entities []GoogleCloudDialogflowV2EntityTypeEntityArgs
    Optional. The collection of entity entries associated with the entity type.
    LanguageCode string
    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    Location string
    Name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.
    Project string
    displayName String
    The name of the entity type.
    kind EntityTypeKind
    Indicates the kind of entity type.
    autoExpansionMode EntityTypeAutoExpansionMode
    Optional. Indicates whether the entity type can be automatically expanded.
    enableFuzzyExtraction Boolean
    Optional. Enables fuzzy entity extraction during classification.
    entities List<GoogleCloudDialogflowV2EntityTypeEntity>
    Optional. The collection of entity entries associated with the entity type.
    languageCode String
    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    location String
    name String
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.
    project String
    displayName string
    The name of the entity type.
    kind EntityTypeKind
    Indicates the kind of entity type.
    autoExpansionMode EntityTypeAutoExpansionMode
    Optional. Indicates whether the entity type can be automatically expanded.
    enableFuzzyExtraction boolean
    Optional. Enables fuzzy entity extraction during classification.
    entities GoogleCloudDialogflowV2EntityTypeEntity[]
    Optional. The collection of entity entries associated with the entity type.
    languageCode string
    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    location string
    name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.
    project string
    display_name str
    The name of the entity type.
    kind EntityTypeKind
    Indicates the kind of entity type.
    auto_expansion_mode EntityTypeAutoExpansionMode
    Optional. Indicates whether the entity type can be automatically expanded.
    enable_fuzzy_extraction bool
    Optional. Enables fuzzy entity extraction during classification.
    entities Sequence[GoogleCloudDialogflowV2EntityTypeEntityArgs]
    Optional. The collection of entity entries associated with the entity type.
    language_code str
    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    location str
    name str
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.
    project str
    displayName String
    The name of the entity type.
    kind "KIND_UNSPECIFIED" | "KIND_MAP" | "KIND_LIST" | "KIND_REGEXP"
    Indicates the kind of entity type.
    autoExpansionMode "AUTO_EXPANSION_MODE_UNSPECIFIED" | "AUTO_EXPANSION_MODE_DEFAULT"
    Optional. Indicates whether the entity type can be automatically expanded.
    enableFuzzyExtraction Boolean
    Optional. Enables fuzzy entity extraction during classification.
    entities List<Property Map>
    Optional. The collection of entity entries associated with the entity type.
    languageCode String
    Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.
    location String
    name String
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: projects//agent/entityTypes/.
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EntityType resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    EntityTypeAutoExpansionMode, EntityTypeAutoExpansionModeArgs

    AutoExpansionModeUnspecified
    AUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AutoExpansionModeDefault
    AUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    EntityTypeAutoExpansionModeAutoExpansionModeUnspecified
    AUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    EntityTypeAutoExpansionModeAutoExpansionModeDefault
    AUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    AutoExpansionModeUnspecified
    AUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AutoExpansionModeDefault
    AUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    AutoExpansionModeUnspecified
    AUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AutoExpansionModeDefault
    AUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    AUTO_EXPANSION_MODE_UNSPECIFIED
    AUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_DEFAULT
    AUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    "AUTO_EXPANSION_MODE_UNSPECIFIED"
    AUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    "AUTO_EXPANSION_MODE_DEFAULT"
    AUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.

    EntityTypeKind, EntityTypeKindArgs

    KindUnspecified
    KIND_UNSPECIFIEDNot specified. This value should be never used.
    KindMap
    KIND_MAPMap entity types allow mapping of a group of synonyms to a reference value.
    KindList
    KIND_LISTList 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).
    KindRegexp
    KIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    EntityTypeKindKindUnspecified
    KIND_UNSPECIFIEDNot specified. This value should be never used.
    EntityTypeKindKindMap
    KIND_MAPMap entity types allow mapping of a group of synonyms to a reference value.
    EntityTypeKindKindList
    KIND_LISTList 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).
    EntityTypeKindKindRegexp
    KIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    KindUnspecified
    KIND_UNSPECIFIEDNot specified. This value should be never used.
    KindMap
    KIND_MAPMap entity types allow mapping of a group of synonyms to a reference value.
    KindList
    KIND_LISTList 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).
    KindRegexp
    KIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    KindUnspecified
    KIND_UNSPECIFIEDNot specified. This value should be never used.
    KindMap
    KIND_MAPMap entity types allow mapping of a group of synonyms to a reference value.
    KindList
    KIND_LISTList 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).
    KindRegexp
    KIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    KIND_UNSPECIFIED
    KIND_UNSPECIFIEDNot specified. This value should be never used.
    KIND_MAP
    KIND_MAPMap entity types allow mapping of a group of synonyms to a reference value.
    KIND_LIST
    KIND_LISTList 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
    KIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    "KIND_UNSPECIFIED"
    KIND_UNSPECIFIEDNot specified. This value should be never used.
    "KIND_MAP"
    KIND_MAPMap entity types allow mapping of a group of synonyms to a reference value.
    "KIND_LIST"
    KIND_LISTList 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"
    KIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.

    GoogleCloudDialogflowV2EntityTypeEntity, GoogleCloudDialogflowV2EntityTypeEntityArgs

    Synonyms List<string>
    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.
    Value string
    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 []string
    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.
    Value string
    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 List<String>
    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.
    value String
    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 string[]
    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.
    value string
    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 Sequence[str]
    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.
    value str
    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 List<String>
    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.
    value String
    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).

    GoogleCloudDialogflowV2EntityTypeEntityResponse, GoogleCloudDialogflowV2EntityTypeEntityResponseArgs

    Synonyms List<string>
    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.
    Value string
    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 []string
    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.
    Value string
    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 List<String>
    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.
    value String
    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 string[]
    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.
    value string
    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 Sequence[str]
    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.
    value str
    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 List<String>
    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.
    value String
    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).

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi