Package com.azure.ai.documentintelligence.models

Class AnalyzeResult

java.lang.Object
com.azure.ai.documentintelligence.models.AnalyzeResult
All Implemented Interfaces:
com.azure.json.JsonSerializable<AnalyzeResult>
public final class AnalyzeResult extends Object implements com.azure.json.JsonSerializable<AnalyzeResult>
Document analysis result.

  • Method Details

    • getApiVersion

      public String getApiVersion()
      Get the apiVersion property: API version used to produce this result.
      Returns:
      the apiVersion value.

    • getModelId

      public String getModelId()
      Get the modelId property: Document model ID used to produce this result.
      Returns:
      the modelId value.

    • getStringIndexType

      public StringIndexType getStringIndexType()
      Get the stringIndexType property: Method used to compute string offset and length.
      Returns:
      the stringIndexType value.

    • getContentFormat

      public DocumentContentFormat getContentFormat()
      Get the contentFormat property: Format of the analyze result top-level content.
      Returns:
      the contentFormat value.

    • getContent

      public String getContent()
      Get the content property: Concatenate string representation of all textual and visual elements in reading order.
      Returns:
      the content value.

    • getPages

      public List<DocumentPage> getPages()
      Get the pages property: Analyzed pages.
      Returns:
      the pages value.

    • getParagraphs

      public List<DocumentParagraph> getParagraphs()
      Get the paragraphs property: Extracted paragraphs.
      Returns:
      the paragraphs value.

    • getTables

      public List<DocumentTable> getTables()
      Get the tables property: Extracted tables.
      Returns:
      the tables value.

    • getFigures

      public List<DocumentFigure> getFigures()
      Get the figures property: Extracted figures.
      Returns:
      the figures value.

    • getSections

      public List<DocumentSection> getSections()
      Get the sections property: Extracted sections.
      Returns:
      the sections value.

    • getKeyValuePairs

      public List<DocumentKeyValuePair> getKeyValuePairs()
      Get the keyValuePairs property: Extracted key-value pairs.
      Returns:
      the keyValuePairs value.

    • getStyles

      public List<DocumentStyle> getStyles()
      Get the styles property: Extracted font styles.
      Returns:
      the styles value.

    • getLanguages

      public List<DocumentLanguage> getLanguages()
      Get the languages property: Detected languages.
      Returns:
      the languages value.

    • getDocuments

      public List<AnalyzedDocument> getDocuments()
      Get the documents property: Extracted documents.
      Returns:
      the documents value.

    • getWarnings

      public List<DocumentIntelligenceWarning> getWarnings()
      Get the warnings property: List of warnings encountered.
      Returns:
      the warnings value.

    • toJson

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

    • fromJson

      public static AnalyzeResult fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AnalyzeResult from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AnalyzeResult 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 AnalyzeResult.