Package com.azure.ai.textanalytics.models

Class ExtractiveSummaryResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.ExtractiveSummaryResult

public final class ExtractiveSummaryResult
extends TextAnalyticsResult

The ExtractiveSummaryResult model.

Constructor Summary

Constructors

Constructor	Description
ExtractiveSummaryResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error)	Creates a ExtractiveSummaryResult model that describes extractive summarization result.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.IterableStream<ExtractiveSummarySentence>	getSentences()	Get the extractive summarization sentence collection.
com.azure.core.util.IterableStream<TextAnalyticsWarning>	getWarnings()	Get 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

ExtractiveSummaryResult

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

Creates a ExtractiveSummaryResult model that describes extractive summarization result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

Method Details

getSentences

public com.azure.core.util.IterableStream<ExtractiveSummarySentence> getSentences()

Get the extractive summarization sentence collection.

Returns:

The extractive summarization sentence collection.

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()

Get the IterableStream of Text Analytics warnings.

Returns:

IterableStream of TextAnalyticsWarning.