Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.dialogflow/v2beta1.EntityType
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
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
new EntityType(name: string, args: EntityTypeArgs, opts?: CustomResourceOptions);
@overload
def EntityType(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_expansion_mode: Optional[EntityTypeAutoExpansionMode] = None,
display_name: Optional[str] = None,
enable_fuzzy_extraction: Optional[bool] = None,
entities: Optional[Sequence[GoogleCloudDialogflowV2beta1EntityTypeEntityArgs]] = None,
kind: Optional[EntityTypeKind] = None,
language_code: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = 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/v2beta1: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:
- Display
Name string The name of the entity type.
- Kind
Pulumi.
Google Native. Dialogflow. V2Beta1. Entity Type Kind Indicates the kind of entity type.
- Auto
Expansion Pulumi.Mode Google Native. Dialogflow. V2Beta1. Entity Type Auto Expansion Mode Optional. Indicates whether the entity type can be automatically expanded.
- Enable
Fuzzy boolExtraction Optional. Enables fuzzy entity extraction during classification.
- Entities
List<Pulumi.
Google Native. Dialogflow. V2Beta1. Inputs. Google Cloud Dialogflow V2beta1Entity Type Entity> Optional. The collection of entity entries associated with the entity type.
- Language
Code 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. Supported formats: -
projects//agent/entityTypes/
-projects//locations//agent/entityTypes/
- Project string
- Display
Name string The name of the entity type.
- Kind
Entity
Type Kind Indicates the kind of entity type.
- Auto
Expansion EntityMode Type Auto Expansion Mode Optional. Indicates whether the entity type can be automatically expanded.
- Enable
Fuzzy boolExtraction Optional. Enables fuzzy entity extraction during classification.
- Entities
[]Google
Cloud Dialogflow V2beta1Entity Type Entity Args Optional. The collection of entity entries associated with the entity type.
- Language
Code 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. Supported formats: -
projects//agent/entityTypes/
-projects//locations//agent/entityTypes/
- Project string
- display
Name String The name of the entity type.
- kind
Entity
Type Kind Indicates the kind of entity type.
- auto
Expansion EntityMode Type Auto Expansion Mode Optional. Indicates whether the entity type can be automatically expanded.
- enable
Fuzzy BooleanExtraction Optional. Enables fuzzy entity extraction during classification.
- entities
List<Google
Cloud Dialogflow V2beta1Entity Type Entity> Optional. The collection of entity entries associated with the entity type.
- language
Code 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. Supported formats: -
projects//agent/entityTypes/
-projects//locations//agent/entityTypes/
- project String
- display
Name string The name of the entity type.
- kind
Entity
Type Kind Indicates the kind of entity type.
- auto
Expansion EntityMode Type Auto Expansion Mode Optional. Indicates whether the entity type can be automatically expanded.
- enable
Fuzzy booleanExtraction Optional. Enables fuzzy entity extraction during classification.
- entities
Google
Cloud Dialogflow V2beta1Entity Type Entity[] Optional. The collection of entity entries associated with the entity type.
- language
Code 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. Supported formats: -
projects//agent/entityTypes/
-projects//locations//agent/entityTypes/
- project string
- display_
name str The name of the entity type.
- kind
Entity
Type Kind Indicates the kind of entity type.
- auto_
expansion_ Entitymode Type Auto Expansion Mode Optional. Indicates whether the entity type can be automatically expanded.
- enable_
fuzzy_ boolextraction Optional. Enables fuzzy entity extraction during classification.
- entities
Sequence[Google
Cloud Dialogflow V2beta1Entity Type Entity Args] 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. Supported formats: -
projects//agent/entityTypes/
-projects//locations//agent/entityTypes/
- project str
- display
Name String The name of the entity type.
- kind "KIND_UNSPECIFIED" | "KIND_MAP" | "KIND_LIST" | "KIND_REGEXP"
Indicates the kind of entity type.
- auto
Expansion "AUTO_EXPANSION_MODE_UNSPECIFIED" | "AUTO_EXPANSION_MODE_DEFAULT"Mode Optional. Indicates whether the entity type can be automatically expanded.
- enable
Fuzzy BooleanExtraction Optional. Enables fuzzy entity extraction during classification.
- entities List<Property Map>
Optional. The collection of entity entries associated with the entity type.
- language
Code 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. Supported formats: -
projects//agent/entityTypes/
-projects//locations//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
- 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.
- Entity
Type Auto Expansion Mode Auto Expansion Mode Unspecified - AUTO_EXPANSION_MODE_UNSPECIFIED
Auto expansion disabled for the entity.
- Entity
Type Auto Expansion Mode 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.
- 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.
- "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
- 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 reference value.
- Kind
List - KIND_LIST
List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).
- Kind
Regexp - KIND_REGEXP
Regexp entity types allow to specify regular expressions in entries values.
- Entity
Type Kind Kind Unspecified - KIND_UNSPECIFIED
Not specified. This value should be never used.
- Entity
Type Kind Kind Map - KIND_MAP
Map entity types allow mapping of a group of synonyms to a reference value.
- Entity
Type Kind Kind List - KIND_LIST
List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).
- Entity
Type Kind 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 reference value.
- Kind
List - KIND_LIST
List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).
- Kind
Regexp - 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 reference value.
- Kind
List - KIND_LIST
List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).
- Kind
Regexp - 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 reference value.
- KIND_LIST
- KIND_LIST
List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).
- KIND_REGEXP
- 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 reference value.
- "KIND_LIST"
- KIND_LIST
List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).
- "KIND_REGEXP"
- KIND_REGEXP
Regexp entity types allow to specify regular expressions in entries values.
GoogleCloudDialogflowV2beta1EntityTypeEntity, GoogleCloudDialogflowV2beta1EntityTypeEntityArgs
- 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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_LIST
entity types: * A string that can contain references to other entity types (with or without aliases).
GoogleCloudDialogflowV2beta1EntityTypeEntityResponse, GoogleCloudDialogflowV2beta1EntityTypeEntityResponseArgs
- 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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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. ForKIND_LIST
entity types: * This collection must contain exactly one synonym equal tovalue
.- 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. ForKIND_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 Cloud Native is in preview. Google Cloud Classic is fully supported.