Package com.azure.ai.documentintelligence.models

Class DocumentLanguage

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentLanguage
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentLanguage>
public final class DocumentLanguage extends Object implements com.azure.json.JsonSerializable<DocumentLanguage>
An object representing the detected language for a given text span.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DocumentLanguage
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of DocumentLanguage from the JsonReader.
    double
    getConfidence()
    Get the confidence property: Confidence of correctly identifying the language.
    String
    getLocale()
    Get the locale property: Detected language.
    List<DocumentSpan>
    getSpans()
    Get the spans property: Location of the text elements in the concatenated content the language applies to.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getLocale

      public String getLocale()
      Get the locale property: Detected language. Value may an ISO 639-1 language code (ex. "en", "fr") or BCP 47 language tag (ex. "zh-Hans").
      Returns:
      the locale value.

    • getSpans

      public List<DocumentSpan> getSpans()
      Get the spans property: Location of the text elements in the concatenated content the language applies to.
      Returns:
      the spans value.

    • getConfidence

      public double getConfidence()
      Get the confidence property: Confidence of correctly identifying the language.
      Returns:
      the confidence value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DocumentLanguage>
      Throws:
      IOException

    • fromJson

      public static DocumentLanguage fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DocumentLanguage from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DocumentLanguage if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the DocumentLanguage.