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

Example Usage - Dialogflow Entity Type Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var basicAgent = new Gcp.Diagflow.Agent("basicAgent", new Gcp.Diagflow.AgentArgs
    {
        DisplayName = "example_agent",
        DefaultLanguageCode = "en",
        TimeZone = "America/New_York",
    });
    var basicEntityType = new Gcp.Diagflow.EntityType("basicEntityType", new Gcp.Diagflow.EntityTypeArgs
    {
        DisplayName = "",
        Kind = "KIND_MAP",
        Entities = 
        {
            new Gcp.Diagflow.Inputs.EntityTypeEntityArgs
            {
                Value = "value1",
                Synonyms = 
                {
                    "synonym1",
                    "synonym2",
                },
            },
            new Gcp.Diagflow.Inputs.EntityTypeEntityArgs
            {
                Value = "value2",
                Synonyms = 
                {
                    "synonym3",
                    "synonym4",
                },
            },
        },
    });
}

}
Inheritance
System.Object
Resource
CustomResource
EntityType
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Gcp.Diagflow
Assembly: Pulumi.Gcp.dll
Syntax
public class EntityType : CustomResource

Constructors

View Source

EntityType(String, EntityTypeArgs, CustomResourceOptions)

Create a EntityType resource with the given unique name, arguments, and options.

Declaration
public EntityType(string name, EntityTypeArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
EntityTypeArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

DisplayName

The name of this entity type to be displayed on the console.

Declaration
public Output<string> DisplayName { get; }
Property Value
Type Description
Output<System.String>
View Source

EnableFuzzyExtraction

Enables fuzzy entity extraction during classification.

Declaration
public Output<bool?> EnableFuzzyExtraction { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Entities

The collection of entity entries associated with the entity type. Structure is documented below.

Declaration
public Output<ImmutableArray<EntityTypeEntity>> Entities { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<EntityTypeEntity>>
View Source

Kind

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.
Declaration
public Output<string> Kind { get; }
Property Value
Type Description
Output<System.String>
View Source

Name

The unique identifier of the entity type. Format: projects/<Project ID>/agent/entityTypes/<Entity type ID>.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration
public Output<string> Project { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, EntityTypeState, CustomResourceOptions)

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

Declaration
public static EntityType Get(string name, Input<string> id, EntityTypeState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
EntityTypeState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
EntityType