Class ExtractKeyPhraseResult
java.lang.Object
com.azure.ai.textanalytics.models.TextAnalyticsResult
com.azure.ai.textanalytics.models.ExtractKeyPhraseResult
The
ExtractKeyPhraseResult
model.-
Constructor Summary
ConstructorDescriptionExtractKeyPhraseResult
(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error, KeyPhrasesCollection keyPhrases) Creates aExtractKeyPhraseResult
model that describes extracted key phrases result. -
Method Summary
Modifier and TypeMethodDescriptionGets aKeyPhrasesCollection
contains a list of key phrases and warnings.Methods inherited from class com.azure.ai.textanalytics.models.TextAnalyticsResult
getError, getId, getStatistics, isError
-
Constructor Details
-
ExtractKeyPhraseResult
public ExtractKeyPhraseResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error, KeyPhrasesCollection keyPhrases) Creates aExtractKeyPhraseResult
model that describes extracted key phrases result.- Parameters:
id
- Unique, non-empty document identifier.textDocumentStatistics
- The text document statistics.error
- The document error.keyPhrases
- AKeyPhrasesCollection
contains a list of key phrases and warnings.
-
-
Method Details
-
getKeyPhrases
Gets aKeyPhrasesCollection
contains a list of key phrases and warnings.- Returns:
- A
KeyPhrasesCollection
contains a list of key phrases and warnings. - Throws:
TextAnalyticsException
- if result hasisError
equals to true and when a non-error property was accessed.
-