Package com.azure.ai.textanalytics.models

Class ExtractSummaryActionResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsActionResult

com.azure.ai.textanalytics.models.ExtractSummaryActionResult

public final class ExtractSummaryActionResult
extends TextAnalyticsActionResult

The ExtractSummaryActionResult model.

Constructor Summary

Constructors

Constructor	Description
ExtractSummaryActionResult()

Method Summary

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

ExtractSummaryActionResult

public ExtractSummaryActionResult()

Method Details

getDocumentsResults

public ExtractSummaryResultCollection 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.