Package com.azure.ai.textanalytics.models

Class AbstractiveSummaryResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.AbstractiveSummaryResult

public final class AbstractiveSummaryResult
extends TextAnalyticsResult

The AbstractiveSummaryResult model.

Constructor Summary

Constructors

Constructor	Description
AbstractiveSummaryResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error)	Creates a AbstractiveSummaryResult model that describes the abstractive summarization result.

Method Summary

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

AbstractiveSummaryResult

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

Creates a AbstractiveSummaryResult 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

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.