Package com.azure.ai.textanalytics.models

Class AnalyzeHealthcareEntitiesResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.AnalyzeHealthcareEntitiesResult

public final class AnalyzeHealthcareEntitiesResult
extends TextAnalyticsResult

The AnalyzeHealthcareEntitiesResult model.

Constructor Summary

Constructors

Constructor	Description
AnalyzeHealthcareEntitiesResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error)	Creates a AnalyzeHealthcareEntitiesResult model that describes recognized healthcare entities result.

Method Summary

Modifier and Type	Method	Description
DetectedLanguage	getDetectedLanguage()	Get the detectedLanguage property: If 'language' is set to 'auto' for the document in the request this field will contain an object of the language detected for this document.
com.azure.core.util.IterableStream<HealthcareEntity>	getEntities()	Gets an IterableStream of HealthcareEntity.
com.azure.core.util.IterableStream<HealthcareEntityRelation>	getEntityRelations()	Gets the IterableStream of HealthcareEntityRelation.
Map<String,Object>	getFhirBundle()	Gets the value of FHIR Bundle.
com.azure.core.util.IterableStream<TextAnalyticsWarning>	getWarnings()	Gets the IterableStream of Text Analytics warnings.

Methods inherited from class com.azure.ai.textanalytics.models.TextAnalyticsResult

getError, getId, getStatistics, isError

Methods inherited from class java.lang.Object

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

Constructor Details

AnalyzeHealthcareEntitiesResult

public AnalyzeHealthcareEntitiesResult(String id,
 TextDocumentStatistics textDocumentStatistics,
 TextAnalyticsError error)

Creates a AnalyzeHealthcareEntitiesResult model that describes recognized healthcare entities result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

Method Details

getEntities

public com.azure.core.util.IterableStream<HealthcareEntity> getEntities()

Gets an IterableStream of HealthcareEntity.

Returns:

An IterableStream of HealthcareEntity.

Throws:

TextAnalyticsException - if result has isError equals to true and when a non-error property was accessed.

getWarnings

public com.azure.core.util.IterableStream<TextAnalyticsWarning> getWarnings()

Gets the IterableStream of Text Analytics warnings.

Returns:

IterableStream of TextAnalyticsWarning.

getEntityRelations

public com.azure.core.util.IterableStream<HealthcareEntityRelation> getEntityRelations()

Gets the IterableStream of HealthcareEntityRelation.

Returns:

The IterableStream of HealthcareEntityRelation.

getFhirBundle

public Map<String,Object> getFhirBundle()

Gets the value of FHIR Bundle. See more information in https://www.hl7.org/fhir/overview.html.

Returns:

The value of FHIR Bundle.

getDetectedLanguage

public DetectedLanguage getDetectedLanguage()

Get the detectedLanguage property: If 'language' is set to 'auto' for the document in the request this field will contain an object of the language detected for this document.

Returns:

the detectedLanguage value.