Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef

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) ⇒ GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef

Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef.



4639
4640
4641
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 4639

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

Instance Attribute Details

#bounding_poly ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2BoundingPoly

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

Returns:



4614
4615
4616
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 4614

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) 


4619
4620
4621
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 4619

def confidence
  @confidence
end

#layout_id ⇒ String

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

Returns:

  • (String) 


4624
4625
4626
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 4624

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) 


4629
4630
4631
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 4629

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) 


4637
4638
4639
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 4637

def page
  @page
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4644
4645
4646
4647
4648
4649
4650
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 4644

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