Compartilhar via

DocumentPage 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.DocumentPage

Implements

JsonSerializable<DocumentPage>

public final class DocumentPage
implements JsonSerializable<DocumentPage>

Content and layout elements extracted from a page from the input.

Method Summary

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

Reads an instance of DocumentPage from the JsonReader.
Double getAngle()

Get the angle property: The general orientation of the content in clockwise direction, measured in degrees between (-180, 180].
List<DocumentBarcode> getBarcodes()

Get the barcodes property: Extracted barcodes from the page.
List<DocumentFormula> getFormulas()

Get the formulas property: Extracted formulas from the page.
Double getHeight()

Get the height property: The height of the image/PDF in pixels/inches, respectively.
List<DocumentLine> getLines()

Get the lines property: Extracted lines from the page, potentially containing both textual and visual elements.
int getPageNumber()

Get the pageNumber property: 1-based page number in the input document.
List<DocumentSelectionMark> getSelectionMarks()

Get the selectionMarks property: Extracted selection marks from the page.
List<DocumentSpan> getSpans()

Get the spans property: Location of the page in the reading order concatenated content.
LengthUnit getUnit()

Get the unit property: The unit used by the width, height, and polygon properties.
Double getWidth()

Get the width property: The width of the image/PDF in pixels/inches, respectively.
List<DocumentWord> getWords()

Get the words property: Extracted words from the page.
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 DocumentPage fromJson(JsonReader jsonReader)

Reads an instance of DocumentPage from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAngle

public Double getAngle()

Get the angle property: The general orientation of the content in clockwise direction, measured in degrees between (-180, 180].

Returns:

the angle value.

getBarcodes

public List getBarcodes()

Get the barcodes property: Extracted barcodes from the page.

Returns:

the barcodes value.

getFormulas

public List getFormulas()

Get the formulas property: Extracted formulas from the page.

Returns:

the formulas value.

getHeight

public Double getHeight()

Get the height property: The height of the image/PDF in pixels/inches, respectively.

Returns:

the height value.

getLines

public List getLines()

Get the lines property: Extracted lines from the page, potentially containing both textual and visual elements.

Returns:

the lines value.

getPageNumber

public int getPageNumber()

Get the pageNumber property: 1-based page number in the input document.

Returns:

the pageNumber value.

getSelectionMarks

public List getSelectionMarks()

Get the selectionMarks property: Extracted selection marks from the page.

Returns:

the selectionMarks value.

getSpans

public List getSpans()

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

Returns:

the spans value.

getUnit

public LengthUnit getUnit()

Get the unit property: The unit used by the width, height, and polygon properties. For images, the unit is "pixel". For PDF, the unit is "inch".

Returns:

the unit value.

getWidth

public Double getWidth()

Get the width property: The width of the image/PDF in pixels/inches, respectively.

Returns:

the width value.

getWords

public List getWords()

Get the words property: Extracted words from the page.

Returns:

the words value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to