Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta3/classes.rb,
lib/google/apis/documentai_v1beta3/representations.rb,
lib/google/apis/documentai_v1beta3/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef

Returns a new instance of GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef.



8113
8114
8115
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8113

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BoundingPoly

A bounding polygon for the detected image annotation. Corresponds to the JSON property boundingPoly

Returns:



8088
8089
8090
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8088

def bounding_poly
  @bounding_poly
end

#confidence ⇒ Float

Optional. Confidence of detected page element, if applicable. Range [0, 1]. Corresponds to the JSON property confidence

Returns:

  • (Float) 


8093
8094
8095
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8093

def confidence
  @confidence
end

#layout_id ⇒ String

Optional. Deprecated. Use PageRef.bounding_poly instead. Corresponds to the JSON property layoutId

Returns:

  • (String) 


8098
8099
8100
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8098

def layout_id
  @layout_id
end

#layout_type ⇒ String

Optional. The type of the layout element that is being referenced if any. Corresponds to the JSON property layoutType

Returns:

  • (String) 


8103
8104
8105
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8103

def layout_type
  @layout_type
end

#page ⇒ Fixnum

Required. Index into the Document.pages element, for example using Document. pages 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. Corresponds to the JSON property page

Returns:

  • (Fixnum) 


8111
8112
8113
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8111

def page
  @page
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8118
8119
8120
8121
8122
8123
8124
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8118

def update!(**args)
  @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly)
  @confidence = args[:confidence] if args.key?(:confidence)
  @layout_id = args[:layout_id] if args.key?(:layout_id)
  @layout_type = args[:layout_type] if args.key?(:layout_type)
  @page = args[:page] if args.key?(:page)
end