public final class EntityType extends GeneratedMessageV3 implements EntityTypeOrBuilder
Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).Protobuf type
google.cloud.dialogflow.v2.EntityType
Modifier and Type | Class and Description |
---|---|
static class |
EntityType.AutoExpansionMode
Represents different entity type expansion modes.
|
static class |
EntityType.Builder
Each intent parameter has a type, called the entity type, which dictates
exactly how data from an end-user expression is extracted.
|
static class |
EntityType.Entity
An **entity entry** for an associated entity type.
|
static interface |
EntityType.EntityOrBuilder |
static class |
EntityType.Kind
Represents kinds of entities.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
AUTO_EXPANSION_MODE_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
ENABLE_FUZZY_EXTRACTION_FIELD_NUMBER |
static int |
ENTITIES_FIELD_NUMBER |
static int |
KIND_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
public static final int AUTO_EXPANSION_MODE_FIELD_NUMBER
public static final int ENTITIES_FIELD_NUMBER
public static final int ENABLE_FUZZY_EXTRACTION_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public String getName()
The unique identifier of the entity type. Required for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2.EntityTypes.UpdateEntityType] and [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes] methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
string name = 1;
getName
in interface EntityTypeOrBuilder
public ByteString getNameBytes()
The unique identifier of the entity type. Required for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2.EntityTypes.UpdateEntityType] and [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes] methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
string name = 1;
getNameBytes
in interface EntityTypeOrBuilder
public String getDisplayName()
Required. The name of the entity type.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
getDisplayName
in interface EntityTypeOrBuilder
public ByteString getDisplayNameBytes()
Required. The name of the entity type.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
getDisplayNameBytes
in interface EntityTypeOrBuilder
public int getKindValue()
Required. Indicates the kind of entity type.
.google.cloud.dialogflow.v2.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
getKindValue
in interface EntityTypeOrBuilder
public EntityType.Kind getKind()
Required. Indicates the kind of entity type.
.google.cloud.dialogflow.v2.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
getKind
in interface EntityTypeOrBuilder
public int getAutoExpansionModeValue()
Optional. Indicates whether the entity type can be automatically expanded.
.google.cloud.dialogflow.v2.EntityType.AutoExpansionMode auto_expansion_mode = 4 [(.google.api.field_behavior) = OPTIONAL];
getAutoExpansionModeValue
in interface EntityTypeOrBuilder
public EntityType.AutoExpansionMode getAutoExpansionMode()
Optional. Indicates whether the entity type can be automatically expanded.
.google.cloud.dialogflow.v2.EntityType.AutoExpansionMode auto_expansion_mode = 4 [(.google.api.field_behavior) = OPTIONAL];
getAutoExpansionMode
in interface EntityTypeOrBuilder
public List<EntityType.Entity> getEntitiesList()
Optional. The collection of entity entries associated with the entity type.
repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];
getEntitiesList
in interface EntityTypeOrBuilder
public List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()
Optional. The collection of entity entries associated with the entity type.
repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];
getEntitiesOrBuilderList
in interface EntityTypeOrBuilder
public int getEntitiesCount()
Optional. The collection of entity entries associated with the entity type.
repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];
getEntitiesCount
in interface EntityTypeOrBuilder
public EntityType.Entity getEntities(int index)
Optional. The collection of entity entries associated with the entity type.
repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];
getEntities
in interface EntityTypeOrBuilder
public EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)
Optional. The collection of entity entries associated with the entity type.
repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 6 [(.google.api.field_behavior) = OPTIONAL];
getEntitiesOrBuilder
in interface EntityTypeOrBuilder
public boolean getEnableFuzzyExtraction()
Optional. Enables fuzzy entity extraction during classification.
bool enable_fuzzy_extraction = 7 [(.google.api.field_behavior) = OPTIONAL];
getEnableFuzzyExtraction
in interface EntityTypeOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static EntityType parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static EntityType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static EntityType parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static EntityType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static EntityType parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static EntityType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static EntityType parseFrom(InputStream input) throws IOException
IOException
public static EntityType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static EntityType parseDelimitedFrom(InputStream input) throws IOException
IOException
public static EntityType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static EntityType parseFrom(CodedInputStream input) throws IOException
IOException
public static EntityType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public EntityType.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static EntityType.Builder newBuilder()
public static EntityType.Builder newBuilder(EntityType prototype)
public EntityType.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected EntityType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static EntityType getDefaultInstance()
public static Parser<EntityType> parser()
public Parser<EntityType> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public EntityType getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2021 Google LLC. All rights reserved.