Package com.azure.ai.textanalytics.models

Class ExtractSummaryResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.ExtractSummaryResult

public final class ExtractSummaryResult
extends TextAnalyticsResult

The ExtractSummaryResult model.

Constructor Summary

Constructors

Constructor	Description
ExtractSummaryResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error)	Creates a ExtractSummaryResult model that describes extractive 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<SummarySentence>	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

ExtractSummaryResult

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

Creates a ExtractSummaryResult model that describes extractive 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.

getSentences

public com.azure.core.util.IterableStream<SummarySentence> 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.