Partilhar via

AnalyzeResult Class

  • Reference
Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.AnalyzeResult

Implements

JsonSerializable<AnalyzeResult>

public final class AnalyzeResult
implements JsonSerializable<AnalyzeResult>

Document analysis result.

Method Summary

Modifier and Type Method and Description
static AnalyzeResult fromJson(JsonReader jsonReader)

Reads an instance of AnalyzeResult from the JsonReader.
String getApiVersion()

Get the apiVersion property: API version used to produce this result.
String getContent()

Get the content property: Concatenate string representation of all textual and visual elements in reading order.
DocumentContentFormat getContentFormat()

Get the contentFormat property: Format of the analyze result top-level content.
List<AnalyzedDocument> getDocuments()

Get the documents property: Extracted documents.
List<DocumentFigure> getFigures()

Get the figures property: Extracted figures.
List<DocumentKeyValuePair> getKeyValuePairs()

Get the keyValuePairs property: Extracted key-value pairs.
List<DocumentLanguage> getLanguages()

Get the languages property: Detected languages.
String getModelId()

Get the modelId property: Document model ID used to produce this result.
List<DocumentPage> getPages()

Get the pages property: Analyzed pages.
List<DocumentParagraph> getParagraphs()

Get the paragraphs property: Extracted paragraphs.
List<DocumentSection> getSections()

Get the sections property: Extracted sections.
StringIndexType getStringIndexType()

Get the stringIndexType property: Method used to compute string offset and length.
List<DocumentStyle> getStyles()

Get the styles property: Extracted font styles.
List<DocumentTable> getTables()

Get the tables property: Extracted tables.
List<DocumentIntelligenceWarning> getWarnings()

Get the warnings property: List of warnings encountered.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static AnalyzeResult fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

getApiVersion

public String getApiVersion()

Get the apiVersion property: API version used to produce this result.

Returns:

the apiVersion 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.

getContentFormat

public DocumentContentFormat getContentFormat()

Get the contentFormat property: Format of the analyze result top-level content.

Returns:

the contentFormat value.

getDocuments

public List getDocuments()

Get the documents property: Extracted documents.

Returns:

the documents value.

getFigures

public List getFigures()

Get the figures property: Extracted figures.

Returns:

the figures value.

getKeyValuePairs

public List getKeyValuePairs()

Get the keyValuePairs property: Extracted key-value pairs.

Returns:

the keyValuePairs value.

getLanguages

public List getLanguages()

Get the languages property: Detected languages.

Returns:

the languages value.

getModelId

public String getModelId()

Get the modelId property: Document model ID used to produce this result.

Returns:

the modelId value.

getPages

public List getPages()

Get the pages property: Analyzed pages.

Returns:

the pages value.

getParagraphs

public List getParagraphs()

Get the paragraphs property: Extracted paragraphs.

Returns:

the paragraphs value.

getSections

public List getSections()

Get the sections property: Extracted sections.

Returns:

the sections value.

getStringIndexType

public StringIndexType getStringIndexType()

Get the stringIndexType property: Method used to compute string offset and length.

Returns:

the stringIndexType value.

getStyles

public List getStyles()

Get the styles property: Extracted font styles.

Returns:

the styles value.

getTables

public List getTables()

Get the tables property: Extracted tables.

Returns:

the tables value.

getWarnings

public List getWarnings()

Get the warnings property: List of warnings encountered.

Returns:

the warnings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to