Class EntityType

public sealed class EntityType : IMessage<EntityType>, IEquatable<EntityType>, IDeepCloneable<EntityType>, IBufferMessage, IMessage

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on.

There are three types of entities:

  • System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the EntityType type.

  • Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a pizza.sauce entity for red or white pizza sauce, a pizza.cheese entity for the different types of cheese on a pizza, a pizza.topping entity for different toppings, and so on. A custom entity is represented by the EntityType type.

  • User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityType] type.

For more information about entity types, see the Dialogflow documentation.

Inheritance

Object > EntityType

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

EntityType()

public EntityType()

EntityType(EntityType)

public EntityType(EntityType other)
Parameter
NameDescription
otherEntityType

Properties

AutoExpansionMode

public EntityType.Types.AutoExpansionMode AutoExpansionMode { get; set; }

Indicates whether the entity type can be automatically expanded.

Property Value
TypeDescription
EntityType.Types.AutoExpansionMode

DisplayName

public string DisplayName { get; set; }

Required. The human-readable name of the entity type, unique within the agent.

Property Value
TypeDescription
String

EnableFuzzyExtraction

public bool EnableFuzzyExtraction { get; set; }

Enables fuzzy entity extraction during classification.

Property Value
TypeDescription
Boolean

Entities

public RepeatedField<EntityType.Types.Entity> Entities { get; }

The collection of entity entries associated with the entity type.

Property Value
TypeDescription
RepeatedField<EntityType.Types.Entity>

EntityTypeName

public EntityTypeName EntityTypeName { get; set; }

EntityTypeName-typed view over the Name resource name property.

Property Value
TypeDescription
EntityTypeName

ExcludedPhrases

public RepeatedField<EntityType.Types.ExcludedPhrase> ExcludedPhrases { get; }

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.

Property Value
TypeDescription
RepeatedField<EntityType.Types.ExcludedPhrase>

Kind

public EntityType.Types.Kind Kind { get; set; }

Required. Indicates the kind of entity type.

Property Value
TypeDescription
EntityType.Types.Kind

Name

public string Name { get; set; }

The unique identifier of the entity type. Required for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType]. Format: projects/&lt;Project ID>/locations/&lt;Location ID>/agents/&lt;Agent ID>/entityTypes/&lt;Entity Type ID>.

Property Value
TypeDescription
String

Redact

public bool Redact { get; set; }

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

Property Value
TypeDescription
Boolean