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

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

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

    Creates an entity type in the specified agent.

    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,
                   agent_id: Optional[str] = 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[GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs]] = None,
                   excluded_phrases: Optional[Sequence[GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseArgs]] = None,
                   language_code: Optional[str] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   project: Optional[str] = None,
                   redact: Optional[bool] = 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/v3beta1:EntityType
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_dialogflow_v3beta1_entity_type" "name" {
        # resource properties
    }

    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.

    Constructor example

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

    var exampleentityTypeResourceResourceFromDialogflowv3beta1 = new GoogleNative.Dialogflow.V3Beta1.EntityType("exampleentityTypeResourceResourceFromDialogflowv3beta1", new()
    {
        AgentId = "string",
        DisplayName = "string",
        Kind = GoogleNative.Dialogflow.V3Beta1.EntityTypeKind.KindUnspecified,
        AutoExpansionMode = GoogleNative.Dialogflow.V3Beta1.EntityTypeAutoExpansionMode.AutoExpansionModeUnspecified,
        EnableFuzzyExtraction = false,
        Entities = new[]
        {
            new GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs
            {
                Synonyms = new[]
                {
                    "string",
                },
                Value = "string",
            },
        },
        ExcludedPhrases = new[]
        {
            new GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseArgs
            {
                Value = "string",
            },
        },
        LanguageCode = "string",
        Location = "string",
        Name = "string",
        Project = "string",
        Redact = false,
    });
    
    example, err := dialogflowv3beta1.NewEntityType(ctx, "exampleentityTypeResourceResourceFromDialogflowv3beta1", &dialogflowv3beta1.EntityTypeArgs{
    	AgentId:               pulumi.String("string"),
    	DisplayName:           pulumi.String("string"),
    	Kind:                  dialogflowv3beta1.EntityTypeKindKindUnspecified,
    	AutoExpansionMode:     dialogflowv3beta1.EntityTypeAutoExpansionModeAutoExpansionModeUnspecified,
    	EnableFuzzyExtraction: pulumi.Bool(false),
    	Entities: dialogflow.GoogleCloudDialogflowCxV3beta1EntityTypeEntityArray{
    		&dialogflow.GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs{
    			Synonyms: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Value: pulumi.String("string"),
    		},
    	},
    	ExcludedPhrases: dialogflow.GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseArray{
    		&dialogflow.GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseArgs{
    			Value: pulumi.String("string"),
    		},
    	},
    	LanguageCode: pulumi.String("string"),
    	Location:     pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	Project:      pulumi.String("string"),
    	Redact:       pulumi.Bool(false),
    })
    
    resource "google-native_dialogflow_v3beta1_entity_type" "exampleentityTypeResourceResourceFromDialogflowv3beta1" {
      lifecycle {
        create_before_destroy = true
      }
      agent_id                = "string"
      display_name            = "string"
      kind                    = "KIND_UNSPECIFIED"
      auto_expansion_mode     = "AUTO_EXPANSION_MODE_UNSPECIFIED"
      enable_fuzzy_extraction = false
      entities {
        synonyms = ["string"]
        value    = "string"
      }
      excluded_phrases {
        value = "string"
      }
      language_code = "string"
      location      = "string"
      name          = "string"
      project       = "string"
      redact        = false
    }
    
    var exampleentityTypeResourceResourceFromDialogflowv3beta1 = new com.pulumi.googlenative.dialogflow_v3beta1.EntityType("exampleentityTypeResourceResourceFromDialogflowv3beta1", com.pulumi.googlenative.dialogflow_v3beta1.EntityTypeArgs.builder()
        .agentId("string")
        .displayName("string")
        .kind(com.pulumi.googlenative.dialogflow_v3beta1.enums.EntityTypeKind.KindUnspecified)
        .autoExpansionMode(com.pulumi.googlenative.dialogflow_v3beta1.enums.EntityTypeAutoExpansionMode.AutoExpansionModeUnspecified)
        .enableFuzzyExtraction(false)
        .entities(GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs.builder()
            .synonyms("string")
            .value("string")
            .build())
        .excludedPhrases(GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseArgs.builder()
            .value("string")
            .build())
        .languageCode("string")
        .location("string")
        .name("string")
        .project("string")
        .redact(false)
        .build());
    
    exampleentity_type_resource_resource_from_dialogflowv3beta1 = google_native.dialogflow.v3beta1.EntityType("exampleentityTypeResourceResourceFromDialogflowv3beta1",
        agent_id="string",
        display_name="string",
        kind=google_native.dialogflow.v3beta1.EntityTypeKind.KIND_UNSPECIFIED,
        auto_expansion_mode=google_native.dialogflow.v3beta1.EntityTypeAutoExpansionMode.AUTO_EXPANSION_MODE_UNSPECIFIED,
        enable_fuzzy_extraction=False,
        entities=[{
            "synonyms": ["string"],
            "value": "string",
        }],
        excluded_phrases=[{
            "value": "string",
        }],
        language_code="string",
        location="string",
        name="string",
        project="string",
        redact=False)
    
    const exampleentityTypeResourceResourceFromDialogflowv3beta1 = new google_native.dialogflow.v3beta1.EntityType("exampleentityTypeResourceResourceFromDialogflowv3beta1", {
        agentId: "string",
        displayName: "string",
        kind: google_native.dialogflow.v3beta1.EntityTypeKind.KindUnspecified,
        autoExpansionMode: google_native.dialogflow.v3beta1.EntityTypeAutoExpansionMode.AutoExpansionModeUnspecified,
        enableFuzzyExtraction: false,
        entities: [{
            synonyms: ["string"],
            value: "string",
        }],
        excludedPhrases: [{
            value: "string",
        }],
        languageCode: "string",
        location: "string",
        name: "string",
        project: "string",
        redact: false,
    });
    
    type: google-native:dialogflow/v3beta1:EntityType
    properties:
        agentId: string
        autoExpansionMode: AUTO_EXPANSION_MODE_UNSPECIFIED
        displayName: string
        enableFuzzyExtraction: false
        entities:
            - synonyms:
                - string
              value: string
        excludedPhrases:
            - value: string
        kind: KIND_UNSPECIFIED
        languageCode: string
        location: string
        name: string
        project: string
        redact: false
    

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EntityType resource accepts the following input properties:

    AgentId string
    DisplayName string
    The human-readable name of the entity type, unique within the agent.
    Kind Pulumi.GoogleNative.Dialogflow.V3Beta1.EntityTypeKind
    Indicates the kind of entity type.
    AutoExpansionMode Pulumi.GoogleNative.Dialogflow.V3Beta1.EntityTypeAutoExpansionMode
    Indicates whether the entity type can be automatically expanded.
    EnableFuzzyExtraction bool
    Enables fuzzy entity extraction during classification.
    Entities List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1EntityTypeEntity>
    The collection of entity entries associated with the entity type.
    ExcludedPhrases List<Pulumi.GoogleNative.Dialogflow.V3Beta1.Inputs.GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhrase>
    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.
    LanguageCode string
    The language of the following fields in entity_type: * 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.
    Location string
    Name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    Project string
    Redact bool
    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 during logging.
    AgentId string
    DisplayName string
    The human-readable name of the entity type, unique within the agent.
    Kind EntityTypeKind
    Indicates the kind of entity type.
    AutoExpansionMode EntityTypeAutoExpansionMode
    Indicates whether the entity type can be automatically expanded.
    EnableFuzzyExtraction bool
    Enables fuzzy entity extraction during classification.
    Entities []GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs
    The collection of entity entries associated with the entity type.
    ExcludedPhrases []GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseArgs
    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.
    LanguageCode string
    The language of the following fields in entity_type: * 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.
    Location string
    Name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    Project string
    Redact bool
    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 during logging.
    agent_id string
    display_name string
    The human-readable name of the entity type, unique within the agent.
    kind "KIND_UNSPECIFIED" | "KIND_MAP" | "KIND_LIST" | "KIND_REGEXP"
    Indicates the kind of entity type.
    auto_expansion_mode "AUTO_EXPANSION_MODE_UNSPECIFIED" | "AUTO_EXPANSION_MODE_DEFAULT"
    Indicates whether the entity type can be automatically expanded.
    enable_fuzzy_extraction bool
    Enables fuzzy entity extraction during classification.
    entities list(object)
    The collection of entity entries associated with the entity type.
    excluded_phrases list(object)
    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.
    language_code string
    The language of the following fields in entity_type: * 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.
    location string
    name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    project string
    redact bool
    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 during logging.
    agentId String
    displayName String
    The human-readable name of the entity type, unique within the agent.
    kind EntityTypeKind
    Indicates the kind of entity type.
    autoExpansionMode EntityTypeAutoExpansionMode
    Indicates whether the entity type can be automatically expanded.
    enableFuzzyExtraction Boolean
    Enables fuzzy entity extraction during classification.
    entities List<GoogleCloudDialogflowCxV3beta1EntityTypeEntity>
    The collection of entity entries associated with the entity type.
    excludedPhrases List<GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhrase>
    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.
    languageCode String
    The language of the following fields in entity_type: * 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.
    location String
    name String
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    project String
    redact Boolean
    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 during logging.
    agentId string
    displayName string
    The human-readable name of the entity type, unique within the agent.
    kind EntityTypeKind
    Indicates the kind of entity type.
    autoExpansionMode EntityTypeAutoExpansionMode
    Indicates whether the entity type can be automatically expanded.
    enableFuzzyExtraction boolean
    Enables fuzzy entity extraction during classification.
    entities GoogleCloudDialogflowCxV3beta1EntityTypeEntity[]
    The collection of entity entries associated with the entity type.
    excludedPhrases GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhrase[]
    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.
    languageCode string
    The language of the following fields in entity_type: * 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.
    location string
    name string
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    project string
    redact boolean
    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 during logging.
    agent_id str
    display_name str
    The human-readable name of the entity type, unique within the agent.
    kind EntityTypeKind
    Indicates the kind of entity type.
    auto_expansion_mode EntityTypeAutoExpansionMode
    Indicates whether the entity type can be automatically expanded.
    enable_fuzzy_extraction bool
    Enables fuzzy entity extraction during classification.
    entities Sequence[GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs]
    The collection of entity entries associated with the entity type.
    excluded_phrases Sequence[GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseArgs]
    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.
    language_code str
    The language of the following fields in entity_type: * 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.
    location str
    name str
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    project str
    redact bool
    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 during logging.
    agentId String
    displayName String
    The human-readable name of the entity type, unique within the agent.
    kind "KIND_UNSPECIFIED" | "KIND_MAP" | "KIND_LIST" | "KIND_REGEXP"
    Indicates the kind of entity type.
    autoExpansionMode "AUTO_EXPANSION_MODE_UNSPECIFIED" | "AUTO_EXPANSION_MODE_DEFAULT"
    Indicates whether the entity type can be automatically expanded.
    enableFuzzyExtraction Boolean
    Enables fuzzy entity extraction during classification.
    entities List<Property Map>
    The collection of entity entries associated with the entity type.
    excludedPhrases List<Property Map>
    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.
    languageCode String
    The language of the following fields in entity_type: * 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.
    location String
    name String
    The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.
    project String
    redact Boolean
    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 during logging.

    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 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.

    Look up Existing EntityType Resource

    Get an existing EntityType resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): EntityType
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> EntityType
    func GetEntityType(ctx *Context, name string, id IDInput, state *EntityTypeState, opts ...ResourceOption) (*EntityType, error)
    public static EntityType Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static EntityType get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingEntityType:    type: google-native:dialogflow/v3beta1:EntityType    get:      id: ${id}
    import {
      to = google-native_dialogflow_v3beta1_entity_type.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state EntityTypeState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    EntityTypeAutoExpansionMode, EntityTypeAutoExpansionModeArgs

    Indicates whether the entity type can be automatically expanded.
    NameValueDescription
    AutoExpansionModeUnspecifiedAUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AutoExpansionModeDefaultAUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    NameValueDescription
    EntityTypeAutoExpansionModeAutoExpansionModeUnspecifiedAUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    EntityTypeAutoExpansionModeAutoExpansionModeDefaultAUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    ValueDescription
    AUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    NameValueDescription
    AutoExpansionModeUnspecifiedAUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AutoExpansionModeDefaultAUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    NameValueDescription
    AutoExpansionModeUnspecifiedAUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AutoExpansionModeDefaultAUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    NameValueDescription
    AUTO_EXPANSION_MODE_UNSPECIFIEDAUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_DEFAULTAUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.
    ValueDescription
    AUTO_EXPANSION_MODE_UNSPECIFIEDAuto expansion disabled for the entity.
    AUTO_EXPANSION_MODE_DEFAULTAllows an agent to recognize values that have not been explicitly listed in the entity.

    EntityTypeKind, EntityTypeKindArgs

    Required. Indicates the kind of entity type.
    NameValueDescription
    KindUnspecifiedKIND_UNSPECIFIEDNot specified. This value should be never used.
    KindMapKIND_MAPMap entity types allow mapping of a group of synonyms to a canonical value.
    KindListKIND_LISTList 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).
    KindRegexpKIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    NameValueDescription
    EntityTypeKindKindUnspecifiedKIND_UNSPECIFIEDNot specified. This value should be never used.
    EntityTypeKindKindMapKIND_MAPMap entity types allow mapping of a group of synonyms to a canonical value.
    EntityTypeKindKindListKIND_LISTList 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).
    EntityTypeKindKindRegexpKIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    ValueDescription
    KIND_UNSPECIFIEDNot specified. This value should be never used.
    KIND_MAPMap entity types allow mapping of a group of synonyms to a canonical value.
    KIND_LISTList 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_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    NameValueDescription
    KindUnspecifiedKIND_UNSPECIFIEDNot specified. This value should be never used.
    KindMapKIND_MAPMap entity types allow mapping of a group of synonyms to a canonical value.
    KindListKIND_LISTList 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).
    KindRegexpKIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    NameValueDescription
    KindUnspecifiedKIND_UNSPECIFIEDNot specified. This value should be never used.
    KindMapKIND_MAPMap entity types allow mapping of a group of synonyms to a canonical value.
    KindListKIND_LISTList 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).
    KindRegexpKIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    NameValueDescription
    KIND_UNSPECIFIEDKIND_UNSPECIFIEDNot specified. This value should be never used.
    KIND_MAPKIND_MAPMap entity types allow mapping of a group of synonyms to a canonical value.
    KIND_LISTKIND_LISTList 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_REGEXPKIND_REGEXPRegexp entity types allow to specify regular expressions in entries values.
    ValueDescription
    KIND_UNSPECIFIEDNot specified. This value should be never used.
    KIND_MAPMap entity types allow mapping of a group of synonyms to a canonical value.
    KIND_LISTList 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_REGEXPRegexp entity types allow to specify regular expressions in entries values.

    GoogleCloudDialogflowCxV3beta1EntityTypeEntity, GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs

    An entity entry for an associated entity type.
    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 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 []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 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 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 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 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 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 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 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 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 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 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 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).

    GoogleCloudDialogflowCxV3beta1EntityTypeEntityResponse, GoogleCloudDialogflowCxV3beta1EntityTypeEntityResponseArgs

    An entity entry for an associated entity type.
    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 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 []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 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 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 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 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 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 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 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 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 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 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 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).

    GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhrase, GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseArgs

    An excluded entity phrase that should not be matched.
    Value string
    The word or phrase to be excluded.
    Value string
    The word or phrase to be excluded.
    value string
    The word or phrase to be excluded.
    value String
    The word or phrase to be excluded.
    value string
    The word or phrase to be excluded.
    value str
    The word or phrase to be excluded.
    value String
    The word or phrase to be excluded.

    GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseResponse, GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseResponseArgs

    An excluded entity phrase that should not be matched.
    Value string
    The word or phrase to be excluded.
    Value string
    The word or phrase to be excluded.
    value string
    The word or phrase to be excluded.
    value String
    The word or phrase to be excluded.
    value string
    The word or phrase to be excluded.
    value str
    The word or phrase to be excluded.
    value String
    The word or phrase to be excluded.

    Package Details

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

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial