Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef (v0.23.0)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#bounding_poly

def bounding_poly() -> ::Google::Cloud::DocumentAI::V1::BoundingPoly

Returns

(::Google::Cloud::DocumentAI::V1::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.

#bounding_poly=

def bounding_poly=(value) -> ::Google::Cloud::DocumentAI::V1::BoundingPoly

Parameter

value (::Google::Cloud::DocumentAI::V1::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.

Returns

(::Google::Cloud::DocumentAI::V1::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

def confidence() -> ::Float

Returns

(::Float) — Optional. Confidence of detected page element, if applicable. Range [0, 1].

#confidence=

def confidence=(value) -> ::Float

Parameter

value (::Float) — Optional. Confidence of detected page element, if applicable. Range [0, 1].

Returns

(::Float) — Optional. Confidence of detected page element, if applicable. Range [0, 1].

#layout_id

def layout_id() -> ::String

Returns

(::String) — Optional. Deprecated. Use PageRef.bounding_poly instead.

#layout_id=

def layout_id=(value) -> ::String

Parameter

value (::String) — Optional. Deprecated. Use PageRef.bounding_poly instead.

Returns

(::String) — Optional. Deprecated. Use PageRef.bounding_poly instead.

#layout_type

def layout_type() -> ::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType

Returns

(::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType) — Optional. The type of the layout element that is being referenced if any.

#layout_type=

def layout_type=(value) -> ::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType

Parameter

value (::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType) — Optional. The type of the layout element that is being referenced if any.

Returns

(::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType) — Optional. The type of the layout element that is being referenced if any.

#page

def page() -> ::Integer

Returns

(::Integer) — 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.

#page=

def page=(value) -> ::Integer

Parameter

value (::Integer) — 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.

Returns

(::Integer) — 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.