Class: Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1/document.rb

Overview

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

Defined Under Namespace

Modules: LayoutType

Instance Attribute Summary collapse

Instance Attribute Details

#bounding_poly ⇒ ::Google::Cloud::DocumentAI::V1::BoundingPoly

Returns 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.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 918

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::V1::Document::Page#blocks Page.blocks}
    # element.
    BLOCK = 1

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs}
    # element.
    PARAGRAPH = 2

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
    LINE = 3

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens}
    # element.
    TOKEN = 4

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements}
    # element.
    VISUAL_ELEMENT = 5

    # Refrrences a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables}
    # element.
    TABLE = 6

    # References a
    # {::Google::Cloud::DocumentAI::V1::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].

Returns:

  • (::Float) —

    Optional. Confidence of detected page element, if applicable. Range [0, 1].



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 918

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::V1::Document::Page#blocks Page.blocks}
    # element.
    BLOCK = 1

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs}
    # element.
    PARAGRAPH = 2

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
    LINE = 3

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens}
    # element.
    TOKEN = 4

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements}
    # element.
    VISUAL_ELEMENT = 5

    # Refrrences a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables}
    # element.
    TABLE = 6

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields}
    # element.
    FORM_FIELD = 7
  end
end

#layout_id ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Optional. Deprecated. Use PageRef.bounding_poly instead.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 918

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::V1::Document::Page#blocks Page.blocks}
    # element.
    BLOCK = 1

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs}
    # element.
    PARAGRAPH = 2

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
    LINE = 3

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens}
    # element.
    TOKEN = 4

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements}
    # element.
    VISUAL_ELEMENT = 5

    # Refrrences a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables}
    # element.
    TABLE = 6

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields}
    # element.
    FORM_FIELD = 7
  end
end

#layout_type ⇒ ::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef::LayoutType

Returns Optional. The type of the layout element that is being referenced if any.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 918

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::V1::Document::Page#blocks Page.blocks}
    # element.
    BLOCK = 1

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs}
    # element.
    PARAGRAPH = 2

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
    LINE = 3

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens}
    # element.
    TOKEN = 4

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements}
    # element.
    VISUAL_ELEMENT = 5

    # Refrrences a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables}
    # element.
    TABLE = 6

    # References a
    # {::Google::Cloud::DocumentAI::V1::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.

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 918

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::V1::Document::Page#blocks Page.blocks}
    # element.
    BLOCK = 1

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs}
    # element.
    PARAGRAPH = 2

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
    LINE = 3

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens}
    # element.
    TOKEN = 4

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements}
    # element.
    VISUAL_ELEMENT = 5

    # Refrrences a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables}
    # element.
    TABLE = 6

    # References a
    # {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields}
    # element.
    FORM_FIELD = 7
  end
end