Package com.azure.ai.textanalytics.models

Class HealthcareEntity

java.lang.Object

com.azure.ai.textanalytics.models.HealthcareEntity

public final class HealthcareEntity
extends Object

The HealthcareEntity model.

Constructor Summary

Constructors

Constructor	Description
HealthcareEntity()	Constructs a HealthcareEntity model.

Method Summary

Modifier and Type	Method	Description
HealthcareEntityAssertion	getAssertion()	Gets the assertion property.
HealthcareEntityCategory	getCategory()	Gets the category property: Healthcare entity category, such as Person/Location/Org/SSN etc.
double	getConfidenceScore()	Gets the score property: If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.
com.azure.core.util.IterableStream<EntityDataSource>	getDataSources()	Gets the healthcare entity data sources property: Entity references in known data sources.
int	getLength()	Gets the length of entity text.
String	getNormalizedText()	Gets the normalized text property: The normalized text is preferred name for the entity.
int	getOffset()	Gets the offset of entity text.
String	getSubcategory()	Gets the subcategory property: Healthcare entity subcategory, such as DateTime etc.
String	getText()	Gets the text property: Healthcare entity text as appears in the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HealthcareEntity

public HealthcareEntity()

Constructs a HealthcareEntity model.

Method Details

getText

public String getText()

Gets the text property: Healthcare entity text as appears in the request.

Returns:

The text value.

getNormalizedText

public String getNormalizedText()

Gets the normalized text property: The normalized text is preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.

Returns:

The normalized text value.

getCategory

public HealthcareEntityCategory getCategory()

Gets the category property: Healthcare entity category, such as Person/Location/Org/SSN etc.

Returns:

The category value.

getSubcategory

public String getSubcategory()

Gets the subcategory property: Healthcare entity subcategory, such as DateTime etc.

Returns:

The subcategory value.

getConfidenceScore

public double getConfidenceScore()

Gets the score property: If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.

Returns:

The score value.

getOffset

public int getOffset()

Gets the offset of entity text. The start position for the entity text in a document.

Returns:

The offset of entity text.

getLength

public int getLength()

Gets the length of entity text.

Returns:

The length of entity text.

getDataSources

public com.azure.core.util.IterableStream<EntityDataSource> getDataSources()

Gets the healthcare entity data sources property: Entity references in known data sources.

Returns:

the dataSources value.

getAssertion

public HealthcareEntityAssertion getAssertion()

Gets the assertion property.

Returns:

the assertion property.