Package com.azure.ai.textanalytics.models

Class EntityCategory

java.lang.Object
com.azure.core.util.ExpandableStringEnum<EntityCategory>
com.azure.ai.textanalytics.models.EntityCategory
public final class EntityCategory extends com.azure.core.util.ExpandableStringEnum<EntityCategory>
Gets the entity category inferred by the text analytics service's named entity recognition model. The list of available categories is described at See named entity types.

  • Field Details

    • ADDRESS

      public static final EntityCategory ADDRESS
      Specifies that the entity corresponds to an address.

    • PERSON

      public static final EntityCategory PERSON
      Specifies that the entity corresponds to a person.

    • PERSON_TYPE

      public static final EntityCategory PERSON_TYPE
      Specifies that the entity corresponds to a person type.

    • LOCATION

      public static final EntityCategory LOCATION
      Specifies that entity contains natural or human-made landmarks, structures, or geographical features.

    • ORGANIZATION

      public static final EntityCategory ORGANIZATION
      Specifies that the entity contains the name of an organization, corporation, agency, or other group of people.

    • EVENT

      public static final EntityCategory EVENT
      Specifies that the entity contains historical, social and natural-occuring events.

    • PRODUCT

      public static final EntityCategory PRODUCT
      Specifies that the entity contains a physical objects of various categories.

    • SKILL

      public static final EntityCategory SKILL
      Specifies that the entity contains an entity describing a capability or expertise.

    • PHONE_NUMBER

      public static final EntityCategory PHONE_NUMBER
      Specifies that the entity contains a phone number (US phone numbers only).

    • EMAIL

      public static final EntityCategory EMAIL
      Specifies that the entity contains an email address.

    • URL

      public static final EntityCategory URL
      Specifies that the entity contains an Internet URL.

    • IP_ADDRESS

      public static final EntityCategory IP_ADDRESS
      Specifies that the entity contains an Internet Protocol address

    • DATE_TIME

      public static final EntityCategory DATE_TIME
      Specifies that the entity contains a date, time or duration.

    • QUANTITY

      public static final EntityCategory QUANTITY
      Specifies that the entity contains a number or numeric quantity.

  • Constructor Details

    • EntityCategory

      @Deprecated public EntityCategory()
      Deprecated.
      Use the fromString(String) factory method.
      Creates a new instance of EntityCategory value.

  • Method Details

    • fromString

      public static EntityCategory fromString(String name)
      Creates or finds a EntityCategory from its string representation.
      Parameters:
      name - The string name to look for.
      Returns:
      The corresponding EntityCategory.

    • values

      public static Collection<EntityCategory> values()
      All known EntityCategory values.
      Returns:
      known EntityCategory values.