com.azure.ai.textanalytics.models

Class DetectedLanguage

java.lang.Object

com.azure.ai.textanalytics.models.DetectedLanguage

public final class DetectedLanguage
extends Object

The DetectedLanguage model.

Constructor Summary

Constructors

Constructor and Description
DetectedLanguage(String name, String iso6391Name, double confidenceScore, com.azure.core.util.IterableStream<TextAnalyticsWarning> warnings) Creates a DetectedLanguage model that describes detected language content.

Method Summary

Modifier and Type	Method and Description
double	getConfidenceScore() Gets the confidenceScore property: A confidence score between 0 and 1.
String	getIso6391Name() Gets the iso6391Name property: A two letter representation of the detected language according to the ISO 639-1 standard (e.g.
String	getName() Gets the name property: Long name of a detected language (e.g.
com.azure.core.util.IterableStream<TextAnalyticsWarning>	getWarnings() Gets the IterableStream of Text Analytics warnings.

Methods inherited from class java.lang.Object

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

Constructor Detail

DetectedLanguage

public DetectedLanguage(String name,
                        String iso6391Name,
                        double confidenceScore,
                        com.azure.core.util.IterableStream<TextAnalyticsWarning> warnings)

Creates a DetectedLanguage model that describes detected language content.

Parameters:

name - The name of a detected language.

iso6391Name - A two letter representation of the detected language according to the ISO 639-1 standard.

confidenceScore - A confidence score between 0 and 1.

warnings - An IterableStream of warnings.

Method Detail

getName

public String getName()

Gets the name property: Long name of a detected language (e.g. English, French).

Returns:

the name value.

getIso6391Name

public String getIso6391Name()

Gets the iso6391Name property: A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr).

Returns:

the iso6391Name value.

getConfidenceScore

public double getConfidenceScore()

Gets the confidenceScore property: A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true.

Returns:

the confidenceScore value.

getWarnings

public com.azure.core.util.IterableStream<TextAnalyticsWarning> getWarnings()

Gets the IterableStream of Text Analytics warnings.

Returns:

IterableStream of TextAnalyticsWarning.