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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1/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

Instance Attribute Details

#page_refs ⇒ ::Array<::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef>

Returns One or more references to visual page elements.

Returns:



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
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
904
905
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 829

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::V1::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::V1::Document::PageAnchor::PageRef::LayoutType]
  #     Optional. The type of the layout element that is being referenced if
  #     any.
  # @!attribute [rw] layout_id
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Optional. Deprecated.  Use
  #     {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
  #     instead.
  # @!attribute [rw] bounding_poly
  #   @return [::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.
  # @!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::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
end