ExtractKeyPhraseResult Class

Package:

com.azure.ai.textanalytics.models

Maven Artifact:

com.azure:azure-ai-textanalytics:5.5.12

• java.lang.Object
• • com.azure.ai.textanalytics.models.TextAnalyticsResult
  • • com.azure.ai.textanalytics.models.ExtractKeyPhraseResult

public final class ExtractKeyPhraseResult
extends TextAnalyticsResult

The ExtractKeyPhraseResult model.

Constructor Summary

Constructor	Description
ExtractKeyPhraseResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error, KeyPhrasesCollection keyPhrases)	Creates a ExtractKeyPhraseResult model that describes extracted key phrases result.

Method Summary

Modifier and Type	Method and Description
KeyPhrasesCollection	getKeyPhrases() Gets a KeyPhrasesCollection contains a list of key phrases and warnings.

Methods inherited from TextAnalyticsResult

getError getId getStatistics isError

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ExtractKeyPhraseResult

public ExtractKeyPhraseResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error, KeyPhrasesCollection keyPhrases)

Creates a ExtractKeyPhraseResult model that describes extracted key phrases result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

keyPhrases - A KeyPhrasesCollection contains a list of key phrases and warnings.

Method Details

getKeyPhrases

public KeyPhrasesCollection getKeyPhrases()

Gets a KeyPhrasesCollection contains a list of key phrases and warnings.

Returns:

A KeyPhrasesCollection contains a list of key phrases and warnings.