1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v3beta1
  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/v3beta1.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.

    Create EntityType Resource

    new EntityType(name: string, args: EntityTypeArgs, opts?: CustomResourceOptions);
    @overload
    def EntityType(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   agent_id: Optional[str] = None,
                   auto_expansion_mode: Optional[EntityTypeAutoExpansionMode] = None,
                   display_name: Optional[str] = None,
                   enable_fuzzy_extraction: Optional[bool] = None,
                   entities: Optional[Sequence[GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs]] = None,
                   excluded_phrases: Optional[Sequence[GoogleCloudDialogflowCxV3beta1EntityTypeExcludedPhraseArgs]] = None,
                   kind: Optional[EntityTypeKind] = None,
                   language_code: Optional[str] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   project: Optional[str] = None,
                   redact: Optional[bool] = None)
    @overload
    def EntityType(resource_name: str,
                   args: EntityTypeArgs,
                   opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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:

    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.

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

    Auto expansion disabled for the entity.

    AutoExpansionModeDefault
    AUTO_EXPANSION_MODE_DEFAULT

    Allows an agent to recognize values that have not been explicitly listed in the entity.

    EntityTypeAutoExpansionModeAutoExpansionModeUnspecified
    AUTO_EXPANSION_MODE_UNSPECIFIED

    Auto expansion disabled for the entity.

    EntityTypeAutoExpansionModeAutoExpansionModeDefault
    AUTO_EXPANSION_MODE_DEFAULT

    Allows an agent to recognize values that have not been explicitly listed in the entity.

    AutoExpansionModeUnspecified
    AUTO_EXPANSION_MODE_UNSPECIFIED

    Auto expansion disabled for the entity.

    AutoExpansionModeDefault
    AUTO_EXPANSION_MODE_DEFAULT

    Allows an agent to recognize values that have not been explicitly listed in the entity.

    AutoExpansionModeUnspecified
    AUTO_EXPANSION_MODE_UNSPECIFIED

    Auto expansion disabled for the entity.

    AutoExpansionModeDefault
    AUTO_EXPANSION_MODE_DEFAULT

    Allows an agent to recognize values that have not been explicitly listed in the entity.

    AUTO_EXPANSION_MODE_UNSPECIFIED
    AUTO_EXPANSION_MODE_UNSPECIFIED

    Auto expansion disabled for the entity.

    AUTO_EXPANSION_MODE_DEFAULT
    AUTO_EXPANSION_MODE_DEFAULT

    Allows an agent to recognize values that have not been explicitly listed in the entity.

    "AUTO_EXPANSION_MODE_UNSPECIFIED"
    AUTO_EXPANSION_MODE_UNSPECIFIED

    Auto expansion disabled for the entity.

    "AUTO_EXPANSION_MODE_DEFAULT"
    AUTO_EXPANSION_MODE_DEFAULT

    Allows an agent to recognize values that have not been explicitly listed in the entity.

    EntityTypeKind, EntityTypeKindArgs

    KindUnspecified
    KIND_UNSPECIFIED

    Not specified. This value should be never used.

    KindMap
    KIND_MAP

    Map entity types allow mapping of a group of synonyms to a canonical value.

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

    KindRegexp
    KIND_REGEXP

    Regexp entity types allow to specify regular expressions in entries values.

    EntityTypeKindKindUnspecified
    KIND_UNSPECIFIED

    Not specified. This value should be never used.

    EntityTypeKindKindMap
    KIND_MAP

    Map entity types allow mapping of a group of synonyms to a canonical value.

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

    EntityTypeKindKindRegexp
    KIND_REGEXP

    Regexp entity types allow to specify regular expressions in entries values.

    KindUnspecified
    KIND_UNSPECIFIED

    Not specified. This value should be never used.

    KindMap
    KIND_MAP

    Map entity types allow mapping of a group of synonyms to a canonical value.

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

    KindRegexp
    KIND_REGEXP

    Regexp entity types allow to specify regular expressions in entries values.

    KindUnspecified
    KIND_UNSPECIFIED

    Not specified. This value should be never used.

    KindMap
    KIND_MAP

    Map entity types allow mapping of a group of synonyms to a canonical value.

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

    KindRegexp
    KIND_REGEXP

    Regexp entity types allow to specify regular expressions in entries values.

    KIND_UNSPECIFIED
    KIND_UNSPECIFIED

    Not specified. This value should be never used.

    KIND_MAP
    KIND_MAP

    Map entity types allow mapping of a group of synonyms to a canonical value.

    KIND_LIST
    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
    KIND_REGEXP

    Regexp entity types allow to specify regular expressions in entries values.

    "KIND_UNSPECIFIED"
    KIND_UNSPECIFIED

    Not specified. This value should be never used.

    "KIND_MAP"
    KIND_MAP

    Map entity types allow mapping of a group of synonyms to a canonical value.

    "KIND_LIST"
    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"
    KIND_REGEXP

    Regexp entity types allow to specify regular expressions in entries values.

    GoogleCloudDialogflowCxV3beta1EntityTypeEntity, GoogleCloudDialogflowCxV3beta1EntityTypeEntityArgs

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

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

    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

    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 is in preview. Google Cloud Classic is fully supported.

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