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.
Protobuf type google.cloud.dialogflow.v2.EntityType
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 |
|
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 |
|
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 |
|
Static Methods
getDefaultInstance()
public static EntityType getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static EntityType.Builder newBuilder()
newBuilder(EntityType prototype)
public static EntityType.Builder newBuilder(EntityType prototype)
public static EntityType parseDelimitedFrom(InputStream input)
public static EntityType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static EntityType parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static EntityType parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(CodedInputStream input)
public static EntityType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(InputStream input)
public static EntityType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static EntityType parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<EntityType> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAutoExpansionMode()
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];
getAutoExpansionModeValue()
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];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for autoExpansionMode.
|
getDefaultInstanceForType()
public EntityType getDefaultInstanceForType()
getDisplayName()
public String getDisplayName()
Required. The name of the entity type.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The name of the entity type.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
public boolean getEnableFuzzyExtraction()
Optional. Enables fuzzy entity extraction during classification.
bool enable_fuzzy_extraction = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The enableFuzzyExtraction.
|
getEntities(int index)
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];
| Parameter |
| Name |
Description |
index |
int
|
getEntitiesCount()
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];
| Returns |
| Type |
Description |
int |
|
getEntitiesList()
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];
getEntitiesOrBuilder(int index)
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];
| Parameter |
| Name |
Description |
index |
int
|
getEntitiesOrBuilderList()
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];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.v2.EntityType.EntityOrBuilder> |
|
getKind()
public EntityType.Kind getKind()
Required. Indicates the kind of entity type.
.google.cloud.dialogflow.v2.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
getKindValue()
public int getKindValue()
Required. Indicates the kind of entity type.
.google.cloud.dialogflow.v2.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for kind.
|
getName()
The unique identifier of the entity type.
Required for
EntityTypes.UpdateEntityType
and
EntityTypes.BatchUpdateEntityTypes
methods. Format: projects/<Project ID>/agent/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
and
EntityTypes.BatchUpdateEntityTypes
methods. Format: projects/<Project ID>/agent/entityTypes/<Entity Type
ID>.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<EntityType> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public EntityType.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EntityType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public EntityType.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
