EntityType

Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries.

To get more information about EntityType, see:

API documentation
How-to Guides
- Official Documentation

Create a EntityType Resource

new EntityType(name: string, args: EntityTypeArgs, opts?: CustomResourceOptions);

def EntityType(resource_name, opts=None, display_name=None, enable_fuzzy_extraction=None, entities=None, kind=None, project=None, __props__=None);

func NewEntityType(ctx *Context, name string, args EntityTypeArgs, opts ...ResourceOption) (*EntityType, error)

public EntityType(string name, EntityTypeArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

EntityType Resource Properties

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

Inputs

The EntityType resource accepts the following input properties:

DisplayName string: The name of this entity type to be displayed on the console.
Kind string: Indicates the kind of entity type. * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value. * 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: Regexp entity types allow to specify regular expressions in entries values.
EnableFuzzyExtraction bool: Enables fuzzy entity extraction during classification.
Entities List<EntityTypeEntityArgs>: The collection of entity entries associated with the entity type. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

DisplayName string: The name of this entity type to be displayed on the console.
Kind string: Indicates the kind of entity type. * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value. * 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: Regexp entity types allow to specify regular expressions in entries values.
EnableFuzzyExtraction bool: Enables fuzzy entity extraction during classification.
Entities []EntityTypeEntity: The collection of entity entries associated with the entity type. Structure is documented below.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

displayName string: The name of this entity type to be displayed on the console.
kind string: Indicates the kind of entity type. * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value. * 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: Regexp entity types allow to specify regular expressions in entries values.
enableFuzzyExtraction boolean: Enables fuzzy entity extraction during classification.
entities EntityTypeEntity[]: The collection of entity entries associated with the entity type. Structure is documented below.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

display_name str: The name of this entity type to be displayed on the console.
kind str: Indicates the kind of entity type. * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value. * 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: Regexp entity types allow to specify regular expressions in entries values.
enable_fuzzy_extraction bool: Enables fuzzy entity extraction during classification.
entities List[EntityTypeEntity]: The collection of entity entries associated with the entity type. Structure is documented below.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

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.
Name string: The unique identifier of the entity type. Format: projects//agent/entityTypes/.

Id string: The provider-assigned unique ID for this managed resource.
Name string: The unique identifier of the entity type. Format: projects//agent/entityTypes/.

id string: The provider-assigned unique ID for this managed resource.
name string: The unique identifier of the entity type. Format: projects//agent/entityTypes/.

id str: The provider-assigned unique ID for this managed resource.
name str: The unique identifier of the entity type. Format: projects//agent/entityTypes/.

Look up an 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>, state?: EntityTypeState, opts?: CustomResourceOptions): EntityType

static get(resource_name, id, opts=None, display_name=None, enable_fuzzy_extraction=None, entities=None, kind=None, name=None, project=None, __props__=None);

func GetEntityType(ctx *Context, name string, id IDInput, state *EntityTypeState, opts ...ResourceOption) (*EntityType, error)

public static EntityType Get(string name, Input<string> id, EntityTypeState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DisplayName string: The name of this entity type to be displayed on the console.
EnableFuzzyExtraction bool: Enables fuzzy entity extraction during classification.
Entities List<EntityTypeEntityArgs>: The collection of entity entries associated with the entity type. Structure is documented below.
Kind string: Indicates the kind of entity type. * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value. * 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: Regexp entity types allow to specify regular expressions in entries values.
Name string: The unique identifier of the entity type. Format: projects//agent/entityTypes/.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

DisplayName string: The name of this entity type to be displayed on the console.
EnableFuzzyExtraction bool: Enables fuzzy entity extraction during classification.
Entities []EntityTypeEntity: The collection of entity entries associated with the entity type. Structure is documented below.
Kind string: Indicates the kind of entity type. * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value. * 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: Regexp entity types allow to specify regular expressions in entries values.
Name string: The unique identifier of the entity type. Format: projects//agent/entityTypes/.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

displayName string: The name of this entity type to be displayed on the console.
enableFuzzyExtraction boolean: Enables fuzzy entity extraction during classification.
entities EntityTypeEntity[]: The collection of entity entries associated with the entity type. Structure is documented below.
kind string: Indicates the kind of entity type. * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value. * 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: Regexp entity types allow to specify regular expressions in entries values.
name string: The unique identifier of the entity type. Format: projects//agent/entityTypes/.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

display_name str: The name of this entity type to be displayed on the console.
enable_fuzzy_extraction bool: Enables fuzzy entity extraction during classification.
entities List[EntityTypeEntity]: The collection of entity entries associated with the entity type. Structure is documented below.
kind str: Indicates the kind of entity type. * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value. * 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: Regexp entity types allow to specify regular expressions in entries values.
name str: The unique identifier of the entity type. Format: projects//agent/entityTypes/.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Supporting Types

EntityTypeEntity

See the input and output API doc for this 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 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 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[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).

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud