Class EntityType (0.17.0) 

public final class EntityType extends GeneratedMessageV3 implements EntityTypeOrBuilder

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 type. For more information about entity types, see the Dialogflow documentation.

Protobuf type google.cloud.dialogflow.cx.v3.EntityType

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > EntityType

Implements

EntityTypeOrBuilder

Static Fields

AUTO_EXPANSION_MODE_FIELD_NUMBER

public static final int AUTO_EXPANSION_MODE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_FUZZY_EXTRACTION_FIELD_NUMBER

public static final int ENABLE_FUZZY_EXTRACTION_FIELD_NUMBER
Field Value
Type Description
int

ENTITIES_FIELD_NUMBER

public static final int ENTITIES_FIELD_NUMBER
Field Value
Type Description
int

EXCLUDED_PHRASES_FIELD_NUMBER

public static final int EXCLUDED_PHRASES_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REDACT_FIELD_NUMBER

public static final int REDACT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EntityType getDefaultInstance()
Returns
Type Description
EntityType

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static EntityType.Builder newBuilder()
Returns
Type Description
EntityType.Builder

newBuilder(EntityType prototype)

public static EntityType.Builder newBuilder(EntityType prototype)
Parameter
Name Description
prototype EntityType
Returns
Type Description
EntityType.Builder

parseDelimitedFrom(InputStream input)

public static EntityType parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EntityType
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EntityType parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EntityType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EntityType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EntityType parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EntityType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EntityType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EntityType parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EntityType
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EntityType parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EntityType
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EntityType parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EntityType
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EntityType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EntityType> parser()
Returns
Type Description
Parser<EntityType>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAutoExpansionMode()

public EntityType.AutoExpansionMode getAutoExpansionMode()

Indicates whether the entity type can be automatically expanded.

.google.cloud.dialogflow.cx.v3.EntityType.AutoExpansionMode auto_expansion_mode = 4;

Returns
Type Description
EntityType.AutoExpansionMode

The autoExpansionMode.

getAutoExpansionModeValue()

public int getAutoExpansionModeValue()

Indicates whether the entity type can be automatically expanded.

.google.cloud.dialogflow.cx.v3.EntityType.AutoExpansionMode auto_expansion_mode = 4;

Returns
Type Description
int

The enum numeric value on the wire for autoExpansionMode.

getDefaultInstanceForType()

public EntityType getDefaultInstanceForType()
Returns
Type Description
EntityType

getDisplayName()

public String getDisplayName()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEnableFuzzyExtraction()

public boolean getEnableFuzzyExtraction()

Enables fuzzy entity extraction during classification.

bool enable_fuzzy_extraction = 7;

Returns
Type Description
boolean

The enableFuzzyExtraction.

getEntities(int index)

public EntityType.Entity getEntities(int index)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityType.Entity

getEntitiesCount()

public int getEntitiesCount()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Returns
Type Description
int

getEntitiesList()

public List<EntityType.Entity> getEntitiesList()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Returns
Type Description
List<Entity>

getEntitiesOrBuilder(int index)

public EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityType.EntityOrBuilder

getEntitiesOrBuilderList()

public List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()

The collection of entity entries associated with the entity type.

repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 5;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.EntityType.EntityOrBuilder>

getExcludedPhrases(int index)

public EntityType.ExcludedPhrase getExcludedPhrases(int index)

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.

repeated .google.cloud.dialogflow.cx.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityType.ExcludedPhrase

getExcludedPhrasesCount()

public int getExcludedPhrasesCount()

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.

repeated .google.cloud.dialogflow.cx.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
int

getExcludedPhrasesList()

public List<EntityType.ExcludedPhrase> getExcludedPhrasesList()

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.

repeated .google.cloud.dialogflow.cx.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
List<ExcludedPhrase>

getExcludedPhrasesOrBuilder(int index)

public EntityType.ExcludedPhraseOrBuilder getExcludedPhrasesOrBuilder(int index)

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.

repeated .google.cloud.dialogflow.cx.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityType.ExcludedPhraseOrBuilder

getExcludedPhrasesOrBuilderList()

public List<? extends EntityType.ExcludedPhraseOrBuilder> getExcludedPhrasesOrBuilderList()

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.

repeated .google.cloud.dialogflow.cx.v3.EntityType.ExcludedPhrase excluded_phrases = 6;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.EntityType.ExcludedPhraseOrBuilder>

getKind()

public EntityType.Kind getKind()

Required. Indicates the kind of entity type.

.google.cloud.dialogflow.cx.v3.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EntityType.Kind

The kind.

getKindValue()

public int getKindValue()

Required. Indicates the kind of entity type.

.google.cloud.dialogflow.cx.v3.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for kind.

getName()

public String getName()

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<EntityType> getParserForType()
Returns
Type Description
Parser<EntityType>
Overrides

getRedact()

public boolean getRedact()

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.

bool redact = 9;

Returns
Type Description
boolean

The redact.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EntityType.Builder newBuilderForType()
Returns
Type Description
EntityType.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EntityType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EntityType.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public EntityType.Builder toBuilder()
Returns
Type Description
EntityType.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException