Reference documentation and code samples for the Google Cloud Document Ai V1 Client class Page.
A page in a Document .
Generated from protobuf message google.cloud.documentai.v1.Document.Page
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ page_number
↳ image
Google\Cloud\DocumentAI\V1\Document\Page\Image
Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
↳ transforms
array< Google\Cloud\DocumentAI\V1\Document\Page\Matrix
>
Transformation matrices that were applied to the original document image to produce Page.image .
↳ dimension
↳ layout
↳ detected_languages
array< Google\Cloud\DocumentAI\V1\Document\Page\DetectedLanguage
>
A list of detected languages together with confidence.
↳ blocks
array< Google\Cloud\DocumentAI\V1\Document\Page\Block
>
A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
↳ paragraphs
array< Google\Cloud\DocumentAI\V1\Document\Page\Paragraph
>
A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
↳ lines
array< Google\Cloud\DocumentAI\V1\Document\Page\Line
>
A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
↳ tokens
array< Google\Cloud\DocumentAI\V1\Document\Page\Token
>
A list of visually detected tokens on the page.
↳ visual_elements
array< Google\Cloud\DocumentAI\V1\Document\Page\VisualElement
>
A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
↳ tables
array< Google\Cloud\DocumentAI\V1\Document\Page\Table
>
A list of visually detected tables on the page.
↳ form_fields
array< Google\Cloud\DocumentAI\V1\Document\Page\FormField
>
A list of visually detected form fields on the page.
↳ symbols
array< Google\Cloud\DocumentAI\V1\Document\Page\Symbol
>
A list of visually detected symbols on the page.
↳ detected_barcodes
↳ image_quality_scores
↳ provenance
getPageNumber
1-based index for current Page in a parent Document .
Useful when a page is taken out of a Document for individual processing.
Generated from protobuf field int32 page_number = 1;
int
setPageNumber
1-based index for current Page in a parent Document .
Useful when a page is taken out of a Document for individual processing.
Generated from protobuf field int32 page_number = 1;
var
int
$this
getImage
Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Image image = 13;
hasImage
clearImage
setImage
Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Image image = 13;
$this
getTransforms
Transformation matrices that were applied to the original document image to produce Page.image .
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;
Google\Protobuf\Internal\RepeatedField
setTransforms
Transformation matrices that were applied to the original document image to produce Page.image .
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Matrix transforms = 14;
$this
getDimension
Physical dimension of the page.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;
hasDimension
clearDimension
setDimension
Physical dimension of the page.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Dimension dimension = 2;
$this
getLayout
Layout for the page.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 3;
hasLayout
clearLayout
setLayout
Layout for the page.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.Layout layout = 3;
$this
getDetectedLanguages
A list of detected languages together with confidence.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;
Google\Protobuf\Internal\RepeatedField
setDetectedLanguages
A list of detected languages together with confidence.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage detected_languages = 4;
$this
getBlocks
A list of visually detected text blocks on the page.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;
Google\Protobuf\Internal\RepeatedField
setBlocks
A list of visually detected text blocks on the page.
A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Block blocks = 5;
$this
getParagraphs
A list of visually detected text paragraphs on the page.
A collection of lines that a human would perceive as a paragraph.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;
Google\Protobuf\Internal\RepeatedField
setParagraphs
A list of visually detected text paragraphs on the page.
A collection of lines that a human would perceive as a paragraph.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Paragraph paragraphs = 6;
$this
getLines
A list of visually detected text lines on the page.
A collection of tokens that a human would perceive as a line.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;
Google\Protobuf\Internal\RepeatedField
setLines
A list of visually detected text lines on the page.
A collection of tokens that a human would perceive as a line.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Line lines = 7;
$this
getTokens
A list of visually detected tokens on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;
Google\Protobuf\Internal\RepeatedField
setTokens
A list of visually detected tokens on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Token tokens = 8;
$this
getVisualElements
A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;
Google\Protobuf\Internal\RepeatedField
setVisualElements
A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.VisualElement visual_elements = 9;
$this
getTables
A list of visually detected tables on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;
Google\Protobuf\Internal\RepeatedField
setTables
A list of visually detected tables on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Table tables = 10;
$this
getFormFields
A list of visually detected form fields on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;
Google\Protobuf\Internal\RepeatedField
setFormFields
A list of visually detected form fields on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.FormField form_fields = 11;
$this
getSymbols
A list of visually detected symbols on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;
Google\Protobuf\Internal\RepeatedField
setSymbols
A list of visually detected symbols on the page.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.Symbol symbols = 12;
$this
getDetectedBarcodes
A list of detected barcodes.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;
Google\Protobuf\Internal\RepeatedField
setDetectedBarcodes
A list of detected barcodes.
Generated from protobuf field repeated .google.cloud.documentai.v1.Document.Page.DetectedBarcode detected_barcodes = 15;
$this
getImageQualityScores
Image Quality Scores.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;
hasImageQualityScores
clearImageQualityScores
setImageQualityScores
Image Quality Scores.
Generated from protobuf field .google.cloud.documentai.v1.Document.Page.ImageQualityScores image_quality_scores = 17;
$this
getProvenance
The history of this page.
Generated from protobuf field .google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];
hasProvenance
clearProvenance
setProvenance
The history of this page.
Generated from protobuf field .google.cloud.documentai.v1.Document.Provenance provenance = 16 [deprecated = true];
$this
