Class: Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor
- Inherits:
-
Object
- Object
- Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/documentai/v1beta3/document.rb
Overview
Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.
Defined Under Namespace
Classes: PageRef
Instance Attribute Summary collapse
-
#page_refs ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef>
One or more references to visual page elements.
Instance Attribute Details
#page_refs ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef>
Returns One or more references to visual page elements.
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 716 class PageAnchor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a weak reference to a page element within a document. # @!attribute [rw] page # @return [::Integer] # Required. Index into the {::Google::Cloud::DocumentAI::V1beta3::Document#pages 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. # @!attribute [rw] layout_type # @return [::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef::LayoutType] # Optional. The type of the layout element that is being referenced if any. # @!attribute [rw] layout_id # @return [::String] # Optional. Deprecated. Use {::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly} instead. # @!attribute [rw] bounding_poly # @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly] # Optional. Identifies the bounding polygon of a layout element on the page. # @!attribute [rw] confidence # @return [::Float] # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. class PageRef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The type of layout that is being referenced. module LayoutType # Layout Unspecified. LAYOUT_TYPE_UNSPECIFIED = 0 # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#blocks Page.blocks} element. BLOCK = 1 # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#paragraphs Page.paragraphs} element. PARAGRAPH = 2 # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#lines Page.lines} element. LINE = 3 # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tokens Page.tokens} element. TOKEN = 4 # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#visual_elements Page.visual_elements} element. VISUAL_ELEMENT = 5 # Refrrences a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#tables Page.tables} element. TABLE = 6 # References a {::Google::Cloud::DocumentAI::V1beta3::Document::Page#form_fields Page.form_fields} element. FORM_FIELD = 7 end end end |