Package com.azure.ai.textanalytics.models

Class AbstractSummaryResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.AbstractSummaryResult

public final class AbstractSummaryResult
extends TextAnalyticsResult

The AbstractSummaryResult model.

Constructor Summary

Constructors

Constructor	Description
AbstractSummaryResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error)	Creates a AbstractSummaryResult model that describes the abstractive summarization 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<AbstractiveSummary>	getSummaries()	Gets the abstractive summaries of document.
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

AbstractSummaryResult

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

Creates a AbstractSummaryResult model that describes the abstractive summarization result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

Method Details

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.

getSummaries

public com.azure.core.util.IterableStream<AbstractiveSummary> getSummaries()

Gets the abstractive summaries of document.

Returns:

The abstractive summaries of document.

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.