Class ExtractSummaryResult
- java.lang.Object
-
- com.azure.ai.textanalytics.models.TextAnalyticsResult
-
- com.azure.ai.textanalytics.models.ExtractSummaryResult
-
public final class ExtractSummaryResult extends TextAnalyticsResult
TheExtractSummaryResult
model.
-
-
Constructor Summary
Constructors Constructor Description ExtractSummaryResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error)
Creates aExtractSummaryResult
model that describes extractive summarization result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SummarySentenceCollection
getSentences()
Get the extractive summarization sentence collection.-
Methods inherited from class com.azure.ai.textanalytics.models.TextAnalyticsResult
getError, getId, getStatistics, isError
-
-
-
-
Constructor Detail
-
ExtractSummaryResult
public ExtractSummaryResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error)
Creates aExtractSummaryResult
model that describes extractive summarization result.- Parameters:
id
- Unique, non-empty document identifier.textDocumentStatistics
- The text document statistics.error
- The document error.
-
-
Method Detail
-
getSentences
public SummarySentenceCollection getSentences()
Get the extractive summarization sentence collection.- Returns:
- The extractive summarization sentence collection.
- Throws:
TextAnalyticsException
- if result hasisError
equals to true and when a non-error property was accessed.
-
-