Class: Google::Cloud::DocumentAI::V1::Document::Page::Layout

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

Overview

Visual element describing a layout unit on a page.

Defined Under Namespace

Modules: Orientation

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns The bounding polygon for the Layout.

Returns:



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 304

class Layout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Detected human reading orientation.
  module Orientation
    # Unspecified orientation.
    ORIENTATION_UNSPECIFIED = 0

    # Orientation is aligned with page up.
    PAGE_UP = 1

    # Orientation is aligned with page right.
    # Turn the head 90 degrees clockwise from upright to read.
    PAGE_RIGHT = 2

    # Orientation is aligned with page down.
    # Turn the head 180 degrees from upright to read.
    PAGE_DOWN = 3

    # Orientation is aligned with page left.
    # Turn the head 90 degrees counterclockwise from upright to read.
    PAGE_LEFT = 4
  end
end

#confidence ⇒ ::Float

Returns Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1].

Returns:

  • (::Float) —

    Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1].



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 304

class Layout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Detected human reading orientation.
  module Orientation
    # Unspecified orientation.
    ORIENTATION_UNSPECIFIED = 0

    # Orientation is aligned with page up.
    PAGE_UP = 1

    # Orientation is aligned with page right.
    # Turn the head 90 degrees clockwise from upright to read.
    PAGE_RIGHT = 2

    # Orientation is aligned with page down.
    # Turn the head 180 degrees from upright to read.
    PAGE_DOWN = 3

    # Orientation is aligned with page left.
    # Turn the head 90 degrees counterclockwise from upright to read.
    PAGE_LEFT = 4
  end
end

#orientation ⇒ ::Google::Cloud::DocumentAI::V1::Document::Page::Layout::Orientation

Returns Detected orientation for the Layout.

Returns:



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 304

class Layout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Detected human reading orientation.
  module Orientation
    # Unspecified orientation.
    ORIENTATION_UNSPECIFIED = 0

    # Orientation is aligned with page up.
    PAGE_UP = 1

    # Orientation is aligned with page right.
    # Turn the head 90 degrees clockwise from upright to read.
    PAGE_RIGHT = 2

    # Orientation is aligned with page down.
    # Turn the head 180 degrees from upright to read.
    PAGE_DOWN = 3

    # Orientation is aligned with page left.
    # Turn the head 90 degrees counterclockwise from upright to read.
    PAGE_LEFT = 4
  end
end

#text_anchor ⇒ ::Google::Cloud::DocumentAI::V1::Document::TextAnchor

Returns Text anchor indexing into the Document.text.

Returns:



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 304

class Layout
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Detected human reading orientation.
  module Orientation
    # Unspecified orientation.
    ORIENTATION_UNSPECIFIED = 0

    # Orientation is aligned with page up.
    PAGE_UP = 1

    # Orientation is aligned with page right.
    # Turn the head 90 degrees clockwise from upright to read.
    PAGE_RIGHT = 2

    # Orientation is aligned with page down.
    # Turn the head 180 degrees from upright to read.
    PAGE_DOWN = 3

    # Orientation is aligned with page left.
    # Turn the head 90 degrees counterclockwise from upright to read.
    PAGE_LEFT = 4
  end
end