Page¶

class oci.ai_document.models.Page(**kwargs)¶

Bases: object

One page document analysis result.

Methods:

__init__(**kwargs)

Initializes a new Page object with values from keyword arguments.

Attributes:

`bar_codes`	Gets the bar_codes of this Page.
`detected_document_types`	Gets the detected_document_types of this Page.
`detected_languages`	Gets the detected_languages of this Page.
`dimensions`	Gets the dimensions of this Page.
`document_fields`	Gets the document_fields of this Page.
`lines`	Gets the lines of this Page.
`page_number`	[Required] Gets the page_number of this Page.
`selection_marks`	Gets the selection_marks of this Page.
`signatures`	Gets the signatures of this Page.
`tables`	Gets the tables of this Page.
`words`	Gets the words of this Page.

__init__(**kwargs)¶

Initializes a new Page object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

page_number (int) – The value to assign to the page_number property of this Page.
dimensions (oci.ai_document.models.Dimensions) – The value to assign to the dimensions property of this Page.
detected_document_types (list[oci.ai_document.models.DetectedDocumentType]) – The value to assign to the detected_document_types property of this Page.
detected_languages (list[oci.ai_document.models.DetectedLanguage]) – The value to assign to the detected_languages property of this Page.
words (list[oci.ai_document.models.Word]) – The value to assign to the words property of this Page.
lines (list[oci.ai_document.models.Line]) – The value to assign to the lines property of this Page.
tables (list[oci.ai_document.models.Table]) – The value to assign to the tables property of this Page.
document_fields (list[oci.ai_document.models.DocumentField]) – The value to assign to the document_fields property of this Page.
signatures (list[oci.ai_document.models.Signature]) – The value to assign to the signatures property of this Page.
bar_codes (list[oci.ai_document.models.BarCode]) – The value to assign to the bar_codes property of this Page.
selection_marks (list[oci.ai_document.models.SelectionMark]) – The value to assign to the selection_marks property of this Page.

property bar_codes¶

Gets the bar_codes of this Page. The bar codes detected on the page.

Returns: The bar_codes of this Page.
Return type: list[oci.ai_document.models.BarCode]

property detected_document_types¶

Gets the detected_document_types of this Page. An array of detected document types.

Returns: The detected_document_types of this Page.
Return type: list[oci.ai_document.models.DetectedDocumentType]

property detected_languages¶

Gets the detected_languages of this Page. An array of detected languages.

Returns: The detected_languages of this Page.
Return type: list[oci.ai_document.models.DetectedLanguage]

property dimensions¶

Gets the dimensions of this Page.

Returns: The dimensions of this Page.
Return type: oci.ai_document.models.Dimensions

property document_fields¶

Gets the document_fields of this Page. The form fields detected on the page.

Returns: The document_fields of this Page.
Return type: list[oci.ai_document.models.DocumentField]

property lines¶

Gets the lines of this Page. The lines of text detected on the page.

Returns: The lines of this Page.
Return type: list[oci.ai_document.models.Line]

property page_number¶

[Required] Gets the page_number of this Page. The document page number.

Returns: The page_number of this Page.
Return type: int

property selection_marks¶

Gets the selection_marks of this Page. The checkboxes and selection marks detected on the page.

Returns: The selection_marks of this Page.
Return type: list[oci.ai_document.models.SelectionMark]

property signatures¶

Gets the signatures of this Page. The signatures detected on the page.

Returns: The signatures of this Page.
Return type: list[oci.ai_document.models.Signature]

property tables¶

Gets the tables of this Page. The tables detected on the page.

Returns: The tables of this Page.
Return type: list[oci.ai_document.models.Table]

property words¶

Gets the words of this Page. The words detected on the page.

Returns: The words of this Page.
Return type: list[oci.ai_document.models.Word]