Share via

AnalyzedDocument Class

Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.6
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.AnalyzedDocument

Implements

JsonSerializable<AnalyzedDocument>

public final class AnalyzedDocument
implements JsonSerializable<AnalyzedDocument>

An object describing the location and semantic content of a document.

Method Summary

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

Reads an instance of AnalyzedDocument from the JsonReader.
List<BoundingRegion> getBoundingRegions()

Get the boundingRegions property: Bounding regions covering the document.
double getConfidence()

Get the confidence property: Confidence of correctly extracting the document.
String getDocumentType()

Get the documentType property: Document type.
Map<String,DocumentField> getFields()

Get the fields property: Dictionary of named field values.
List<DocumentSpan> getSpans()

Get the spans property: Location of the document in the reading order concatenated content.
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 AnalyzedDocument fromJson(JsonReader jsonReader)

Reads an instance of AnalyzedDocument from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AnalyzedDocument 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.

getBoundingRegions

public List<BoundingRegion> getBoundingRegions()

Get the boundingRegions property: Bounding regions covering the document.

Returns:

the boundingRegions value.

getConfidence

public double getConfidence()

Get the confidence property: Confidence of correctly extracting the document.

Returns:

the confidence value.

getDocumentType

public String getDocumentType()

Get the documentType property: Document type.

Returns:

the documentType value.

getFields

public Map<String,DocumentField> getFields()

Get the fields property: Dictionary of named field values.

Returns:

the fields value.

getSpans

public List<DocumentSpan> getSpans()

Get the spans property: Location of the document in the reading order concatenated content.

Returns:

the spans value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to