Package com.azure.ai.textanalytics.models

Class ExtractiveSummaryActionResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsActionResult

com.azure.ai.textanalytics.models.ExtractiveSummaryActionResult

public final class ExtractiveSummaryActionResult
extends TextAnalyticsActionResult

The ExtractiveSummaryActionResult model.

Constructor Summary

Constructors

Constructor	Description
ExtractiveSummaryActionResult()	Constructs a ExtractiveSummaryActionResult model.

Method Summary

Modifier and Type	Method	Description
ExtractiveSummaryResultCollection	getDocumentsResults()	Gets the extractive summarization action result.

Methods inherited from class com.azure.ai.textanalytics.models.TextAnalyticsActionResult

getActionName, getCompletedAt, getError, isError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExtractiveSummaryActionResult

public ExtractiveSummaryActionResult()

Constructs a ExtractiveSummaryActionResult model.

Method Details

getDocumentsResults

public ExtractiveSummaryResultCollection getDocumentsResults()

Gets the extractive summarization action result.

Returns:

The extractive summarization action result.

Throws:

TextAnalyticsException - if result has isError equals to true and when a non-error property was accessed.