com.azure.ai.textanalytics.models

Class DetectLanguageResult

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsResult

com.azure.ai.textanalytics.models.DetectLanguageResult

public final class DetectLanguageResult
extends TextAnalyticsResult

The DetectLanguageResult model.

Constructor Summary

Constructors

Constructor and Description
DetectLanguageResult(String id, TextDocumentStatistics textDocumentStatistics, TextAnalyticsError error, DetectedLanguage primaryLanguage) Creates a DetectLanguageResult model that describes detected languages result.

Method Summary

Modifier and Type	Method and Description
DetectedLanguage	getPrimaryLanguage() Gets the detected primary language.

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

getError, getId, getStatistics, isError

Methods inherited from class java.lang.Object

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

Constructor Detail

DetectLanguageResult

public DetectLanguageResult(String id,
                            TextDocumentStatistics textDocumentStatistics,
                            TextAnalyticsError error,
                            DetectedLanguage primaryLanguage)

Creates a DetectLanguageResult model that describes detected languages result.

Parameters:

id - Unique, non-empty document identifier.

textDocumentStatistics - The text document statistics.

error - The document error.

primaryLanguage - The detected primary language.

Method Detail

getPrimaryLanguage

public DetectedLanguage getPrimaryLanguage()

Gets the detected primary language.

Returns:

The detected language.

Throws:

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