Class: Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef
- Inherits:
-
Object
- Object
- Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/documentai/v1beta3/document.rb
Overview
Represents a weak reference to a page element within a document.
Defined Under Namespace
Modules: LayoutType
Instance Attribute Summary collapse
-
#bounding_poly ⇒ ::Google::Cloud::DocumentAI::V1beta3::BoundingPoly
Optional.
-
#confidence ⇒ ::Float
Optional.
-
#layout_id ⇒ ::String
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#layout_type ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef::LayoutType
Optional.
-
#page ⇒ ::Integer
Required.
Instance Attribute Details
#bounding_poly ⇒ ::Google::Cloud::DocumentAI::V1beta3::BoundingPoly
Returns Optional. Identifies the bounding polygon of a layout element on the page.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 859 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 |
#confidence ⇒ ::Float
Returns Optional. Confidence of detected page element, if applicable. Range
[0, 1]
.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 859 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 |
#layout_id ⇒ ::String
This field is deprecated and may be removed in the next major version update.
Returns Optional. Deprecated. Use PageRef.bounding_poly instead.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 859 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 |
#layout_type ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef::LayoutType
Returns Optional. The type of the layout element that is being referenced if any.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 859 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 |
#page ⇒ ::Integer
Returns 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.
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 |
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 859 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 |