Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

EntityType

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:

DisplayName string

The name of the entity type.

Kind Pulumi.GoogleNative.Dialogflow.V2Beta1.EntityTypeKind

Indicates the kind of entity type.

AutoExpansionMode Pulumi.GoogleNative.Dialogflow.V2Beta1.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.V2Beta1.Inputs.GoogleCloudDialogflowV2beta1EntityTypeEntityArgs>

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. Supported formats: - projects//agent/entityTypes/ - projects//locations//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 []GoogleCloudDialogflowV2beta1EntityTypeEntityArgs

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. Supported formats: - projects//agent/entityTypes/ - projects//locations//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<GoogleCloudDialogflowV2beta1EntityTypeEntityArgs>

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. Supported formats: - projects//agent/entityTypes/ - projects//locations//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 GoogleCloudDialogflowV2beta1EntityTypeEntityArgs[]

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. Supported formats: - projects//agent/entityTypes/ - projects//locations//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[GoogleCloudDialogflowV2beta1EntityTypeEntityArgs]

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

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

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

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

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

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

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

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

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

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

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

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

GoogleCloudDialogflowV2beta1EntityTypeEntityResponse

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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0