Package com.azure.ai.textanalytics.models

Class ExtractKeyPhrasesActionResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsActionResult

com.azure.ai.textanalytics.models.ExtractKeyPhrasesActionResult

public final class ExtractKeyPhrasesActionResult
extends TextAnalyticsActionResult

The ExtractKeyPhrasesActionResult model.

Constructor Summary

Constructors

Constructor	Description
ExtractKeyPhrasesActionResult()	Constructs a ExtractKeyPhrasesActionResult model.

Method Summary

Modifier and Type	Method	Description
ExtractKeyPhrasesResultCollection	getDocumentsResults()	Gets the key phrases extraction 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

ExtractKeyPhrasesActionResult

public ExtractKeyPhrasesActionResult()

Constructs a ExtractKeyPhrasesActionResult model.

Method Details

getDocumentsResults

public ExtractKeyPhrasesResultCollection getDocumentsResults()

Gets the key phrases extraction action result.

Returns:

The key phrases extraction action result.

Throws:

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