Package com.google.cloud.dialogflow.cx.v3beta1

Class EntityType

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.EntityType
All Implemented Interfaces:
EntityTypeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class EntityType extends com.google.protobuf.GeneratedMessage 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][google.cloud.dialogflow.cx.v3beta1.SessionEntityType]
 type.

 For more information about entity types, see the [Dialogflow
 documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
Protobuf type google.cloud.dialogflow.cx.v3beta1.EntityType
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • KIND_FIELD_NUMBER

      public static final int KIND_FIELD_NUMBER
      See Also:

    • AUTO_EXPANSION_MODE_FIELD_NUMBER

      public static final int AUTO_EXPANSION_MODE_FIELD_NUMBER
      See Also:

    • ENTITIES_FIELD_NUMBER

      public static final int ENTITIES_FIELD_NUMBER
      See Also:

    • EXCLUDED_PHRASES_FIELD_NUMBER

      public static final int EXCLUDED_PHRASES_FIELD_NUMBER
      See Also:

    • ENABLE_FUZZY_EXTRACTION_FIELD_NUMBER

      public static final int ENABLE_FUZZY_EXTRACTION_FIELD_NUMBER
      See Also:

    • REDACT_FIELD_NUMBER

      public static final int REDACT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       The unique identifier of the entity type.
 Required for
 [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3beta1.EntityTypes.UpdateEntityType].
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
      string name = 1;
      Specified by:
      getName in interface EntityTypeOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The unique identifier of the entity type.
 Required for
 [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3beta1.EntityTypes.UpdateEntityType].
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
      string name = 1;
      Specified by:
      getNameBytes in interface EntityTypeOrBuilder
      Returns:
      The bytes for name.

    • 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];
      Specified by:
      getDisplayName in interface EntityTypeOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The human-readable name of the entity type, unique within the
 agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface EntityTypeOrBuilder
      Returns:
      The bytes for displayName.

    • getKindValue

      public int getKindValue()
       Required. Indicates the kind of entity type.
      .google.cloud.dialogflow.cx.v3beta1.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getKindValue in interface EntityTypeOrBuilder
      Returns:
      The enum numeric value on the wire for kind.

    • getKind

      public EntityType.Kind getKind()
       Required. Indicates the kind of entity type.
      .google.cloud.dialogflow.cx.v3beta1.EntityType.Kind kind = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getKind in interface EntityTypeOrBuilder
      Returns:
      The kind.

    • getAutoExpansionModeValue

      public int getAutoExpansionModeValue()
       Indicates whether the entity type can be automatically expanded.
      .google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode auto_expansion_mode = 4;
      Specified by:
      getAutoExpansionModeValue in interface EntityTypeOrBuilder
      Returns:
      The enum numeric value on the wire for autoExpansionMode.

    • getAutoExpansionMode

      public EntityType.AutoExpansionMode getAutoExpansionMode()
       Indicates whether the entity type can be automatically expanded.
      .google.cloud.dialogflow.cx.v3beta1.EntityType.AutoExpansionMode auto_expansion_mode = 4;
      Specified by:
      getAutoExpansionMode in interface EntityTypeOrBuilder
      Returns:
      The autoExpansionMode.

    • getEntitiesList

      public List<EntityType.Entity> getEntitiesList()
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;
      Specified by:
      getEntitiesList in interface EntityTypeOrBuilder

    • getEntitiesOrBuilderList

      public List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;
      Specified by:
      getEntitiesOrBuilderList in interface EntityTypeOrBuilder

    • getEntitiesCount

      public int getEntitiesCount()
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;
      Specified by:
      getEntitiesCount in interface EntityTypeOrBuilder

    • getEntities

      public EntityType.Entity getEntities(int index)
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;
      Specified by:
      getEntities in interface EntityTypeOrBuilder

    • getEntitiesOrBuilder

      public EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)
       The collection of entity entries associated with the entity type.
      repeated .google.cloud.dialogflow.cx.v3beta1.EntityType.Entity entities = 5;
      Specified by:
      getEntitiesOrBuilder in interface EntityTypeOrBuilder

    • 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.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;
      Specified by:
      getExcludedPhrasesList in interface EntityTypeOrBuilder

    • 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.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;
      Specified by:
      getExcludedPhrasesOrBuilderList in interface EntityTypeOrBuilder

    • 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.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;
      Specified by:
      getExcludedPhrasesCount in interface EntityTypeOrBuilder

    • getExcludedPhrases

      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.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;
      Specified by:
      getExcludedPhrases in interface EntityTypeOrBuilder

    • getExcludedPhrasesOrBuilder

      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.v3beta1.EntityType.ExcludedPhrase excluded_phrases = 6;
      Specified by:
      getExcludedPhrasesOrBuilder in interface EntityTypeOrBuilder

    • getEnableFuzzyExtraction

      public boolean getEnableFuzzyExtraction()
       Enables fuzzy entity extraction during classification.
      bool enable_fuzzy_extraction = 7;
      Specified by:
      getEnableFuzzyExtraction in interface EntityTypeOrBuilder
      Returns:
      The enableFuzzyExtraction.

    • 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 during logging.
      bool redact = 9;
      Specified by:
      getRedact in interface EntityTypeOrBuilder
      Returns:
      The redact.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static EntityType parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EntityType parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EntityType parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EntityType parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EntityType parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EntityType parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public EntityType.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static EntityType.Builder newBuilder()

    • newBuilder

      public static EntityType.Builder newBuilder(EntityType prototype)

    • toBuilder

      public EntityType.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected EntityType.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static EntityType getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<EntityType> parser()

    • getParserForType

      public com.google.protobuf.Parser<EntityType> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public EntityType getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder