Freigeben über

DocumentPage Class

Package:
com.azure.ai.contentunderstanding.models
Maven Artifact:
com.azure:azure-ai-contentunderstanding:1.0.0
  • java.lang.Object
    • com.azure.ai.contentunderstanding.models.DocumentPage

Implements

JsonSerializable<DocumentPage>

public final class DocumentPage
implements JsonSerializable<DocumentPage>

Content from a document page.

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: List of barcodes in the page.
List<DocumentFormula> getFormulas()

Get the formulas property: List of mathematical formulas in the page.
Double getHeight()

Get the height property: Height of the page.
List<DocumentLine> getLines()

Get the lines property: List of lines in the page.
int getPageNumber()

Get the pageNumber property: Page number (1-based).
List<ContentSpan> getSpans()

Get the spans property: Span(s) associated with the page in the markdown content.
Double getWidth()

Get the width property: Width of the page.
List<DocumentWord> getWords()

Get the words property: List of words in 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]. Only if enableOcr is true.

Returns:

the angle value.

getBarcodes

public List<DocumentBarcode> getBarcodes()

Get the barcodes property: List of barcodes in the page. Only if enableBarcode and returnDetails are true.

Returns:

the barcodes value.

getFormulas

public List<DocumentFormula> getFormulas()

Get the formulas property: List of mathematical formulas in the page. Only if enableFormula and returnDetails are true.

Returns:

the formulas value.

getHeight

public Double getHeight()

Get the height property: Height of the page.

Returns:

the height value.

getLines

public List<DocumentLine> getLines()

Get the lines property: List of lines in the page. Only if enableOcr and returnDetails are true.

Returns:

the lines value.

getPageNumber

public int getPageNumber()

Get the pageNumber property: Page number (1-based).

Returns:

the pageNumber value.

getSpans

public List<ContentSpan> getSpans()

Get the spans property: Span(s) associated with the page in the markdown content.

Returns:

the spans value.

getWidth

public Double getWidth()

Get the width property: Width of the page.

Returns:

the width value.

getWords

public List<DocumentWord> getWords()

Get the words property: List of words in the page. Only if enableOcr and returnDetails are true.

Returns:

the words value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to