Class PageRef (2.25.0)

Version 2.25.0

• 3.0.1 (latest)
• 3.0.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.3
• 2.28.0
• 2.27.1
• 2.26.0
• 2.25.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

PageRef(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a weak reference to a page element within a document.

Attributes
Name	Description
page	int Required. Index into the Document.pages element, for example using Document.pages][page_refs.page] to locate the related page element. This field is skipped when its value is the default 0. See https://developers.google.com/protocol-buffers/docs/proto3#json.
layout_type	google.cloud.documentai_v1.types.Document.PageAnchor.PageRef.LayoutType Optional. The type of the layout element that is being referenced if any.
layout_id	str Optional. Deprecated. Use PageRef.bounding_poly instead.
bounding_poly	google.cloud.documentai_v1.types.BoundingPoly Optional. Identifies the bounding polygon of a layout element on the page. If layout_type is set, the bounding polygon must be exactly the same to the layout element it's referring to.
confidence	float Optional. Confidence of detected page element, if applicable. Range [0, 1].

Classes

LayoutType

LayoutType(value)

The type of layout that is being referenced.

Values: LAYOUT_TYPE_UNSPECIFIED (0): Layout Unspecified. BLOCK (1): References a Page.blocks element. PARAGRAPH (2): References a Page.paragraphs element. LINE (3): References a Page.lines element. TOKEN (4): References a Page.tokens element. VISUAL_ELEMENT (5): References a Page.visual_elements element. TABLE (6): Refrrences a Page.tables element. FORM_FIELD (7): References a Page.form_fields element.