EntityCategory Class

Package:: com.azure.ai.textanalytics.models

Maven Artifact:: com.azure:azure-ai-textanalytics:5.5.12

java.lang.Object
- com.azure.core.util.ExpandableStringEnum<T>
- - com.azure.ai.textanalytics.models.EntityCategory

public final class EntityCategory
extends 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 Summary

Modifier and Type	Field and Description
static final EntityCategory	ADDRESS Specifies that the entity corresponds to an address.
static final EntityCategory	DATE_TIME Specifies that the entity contains a date, time or duration.
static final EntityCategory	EMAIL Specifies that the entity contains an email address.
static final EntityCategory	EVENT Specifies that the entity contains historical, social and natural-occuring events.
static final EntityCategory	IP_ADDRESS Specifies that the entity contains an Internet Protocol address
static final EntityCategory	LOCATION Specifies that entity contains natural or human-made landmarks, structures, or geographical features.
static final EntityCategory	ORGANIZATION Specifies that the entity contains the name of an organization, corporation, agency, or other group of people.
static final EntityCategory	PERSON Specifies that the entity corresponds to a person.
static final EntityCategory	PERSON_TYPE Specifies that the entity corresponds to a person type.
static final EntityCategory	PHONE_NUMBER Specifies that the entity contains a phone number (US phone numbers only).
static final EntityCategory	PRODUCT Specifies that the entity contains a physical objects of various categories.
static final EntityCategory	QUANTITY Specifies that the entity contains a number or numeric quantity.
static final EntityCategory	SKILL Specifies that the entity contains an entity describing a capability or expertise.
static final EntityCategory	URL Specifies that the entity contains an Internet URL.

Constructor Summary

Constructor Description

Constructor	Description
EntityCategory()	Deprecated Use the fromString(String name) factory method. Creates a new instance of `EntityCategory` value.

EntityCategory()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of EntityCategory value.

Method Summary

Modifier and Type	Method and Description
static EntityCategory	fromString(String name) Creates or finds a `EntityCategory` from its string representation.
static Collection<EntityCategory>	values() All known EntityCategory values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

ADDRESS

public static final EntityCategory ADDRESS

Specifies that the entity corresponds to an address.

DATE_TIME

public static final EntityCategory DATE_TIME

Specifies that the entity contains a date, time or duration.

EMAIL

public static final EntityCategory EMAIL

Specifies that the entity contains an email address.

EVENT

public static final EntityCategory EVENT

Specifies that the entity contains historical, social and natural-occuring events.

IP_ADDRESS

public static final EntityCategory IP_ADDRESS

Specifies that the entity contains an Internet Protocol address

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.

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.

PHONE_NUMBER

public static final EntityCategory PHONE_NUMBER

Specifies that the entity contains a phone number (US phone numbers only).

PRODUCT

public static final EntityCategory PRODUCT

Specifies that the entity contains a physical objects of various categories.

QUANTITY

public static final EntityCategory QUANTITY

Specifies that the entity contains a number or numeric quantity.

SKILL

public static final EntityCategory SKILL

Specifies that the entity contains an entity describing a capability or expertise.

URL

public static final EntityCategory URL

Specifies that the entity contains an Internet URL.

Constructor Details

EntityCategory

@Deprecated
public EntityCategory()

Deprecated

Use the fromString(String name) 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.