HealthcareEntity Class

Package:

com.azure.ai.textanalytics.models

Maven Artifact:

com.azure:azure-ai-textanalytics:5.5.12

• java.lang.Object
• • com.azure.ai.textanalytics.models.HealthcareEntity

public final class HealthcareEntity

The HealthcareEntity model.

Constructor Summary

Constructor	Description
HealthcareEntity()	Constructs a HealthcareEntity model.

Method Summary

Modifier and Type	Method and 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.
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 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

getAssertion

public HealthcareEntityAssertion getAssertion()

Gets the assertion property.

Returns:

the assertion property.

getCategory

public HealthcareEntityCategory getCategory()

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

Returns:

The category 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.

getDataSources

public IterableStream<EntityDataSource> getDataSources()

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

Returns:

the dataSources value.

getLength

public int getLength()

Gets the length of entity text.

Returns:

The length of entity text.

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.

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.

getSubcategory

public String getSubcategory()

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

Returns:

The subcategory value.

getText

public String getText()

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

Returns:

The text value.