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.



5978
5979
5980
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5978

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:



5953
5954
5955
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5953

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) 


5958
5959
5960
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5958

def confidence
  @confidence
end

#layout_id ⇒ String

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

Returns:

  • (String) 


5963
5964
5965
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5963

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) 


5968
5969
5970
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5968

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) 


5976
5977
5978
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5976

def page
  @page
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5983
5984
5985
5986
5987
5988
5989
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5983

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