Class PageRef (2.24.0)

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

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

Attributes

NameDescription
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_v1beta3.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_v1beta3.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.