Class: Google::Cloud::DocumentAI::V1beta3::Document::Page::Token

Inherits:

Object

• Object
• Google::Cloud::DocumentAI::V1beta3::Document::Page::Token

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/documentai/v1beta3/document.rb

Overview

A detected token.

Defined Under Namespace

Classes: DetectedBreak, StyleInfo

Instance Attribute Summary

• #detected_break ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak

  Detected break at the end of a Token.

• #detected_languages ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>

  A list of detected languages together with confidence.

• #layout ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout

  Layout for Token.

• #provenance ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Provenance

  The history of this annotation.

• #style_info ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo

  Text style attributes.

Instance Attribute Details

#detected_break ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak

Returns Detected break at the end of a Token.

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak) —

  Detected break at the end of a Token.

# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 394

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

  # Detected break at the end of a
  # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak::Type]
  #     Detected break type.
  class DetectedBreak
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to denote the type of break found.
    module Type
      # Unspecified break type.
      TYPE_UNSPECIFIED = 0

      # A single whitespace.
      SPACE = 1

      # A wider whitespace.
      WIDE_SPACE = 2

      # A hyphen that indicates that a token has been split across lines.
      HYPHEN = 3
    end
  end

  # Font and other text style attributes.
  # @!attribute [rw] font_size
  #   @return [::Integer]
  #     Font size in points (`1` point is `¹⁄₇₂` inches).
  # @!attribute [rw] pixel_font_size
  #   @return [::Float]
  #     Font size in pixels, equal to _unrounded
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_size font_size}_
  #     * _resolution_ ÷ `72.0`.
  # @!attribute [rw] letter_spacing
  #   @return [::Float]
  #     Letter spacing in points.
  # @!attribute [rw] font_type
  #   @return [::String]
  #     Name or style of the font.
  # @!attribute [rw] bold
  #   @return [::Boolean]
  #     Whether the text is bold (equivalent to
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_weight font_weight}
  #     is at least `700`).
  # @!attribute [rw] italic
  #   @return [::Boolean]
  #     Whether the text is italic.
  # @!attribute [rw] underlined
  #   @return [::Boolean]
  #     Whether the text is underlined.
  # @!attribute [rw] strikeout
  #   @return [::Boolean]
  #     Whether the text is strikethrough.
  # @!attribute [rw] subscript
  #   @return [::Boolean]
  #     Whether the text is a subscript.
  # @!attribute [rw] superscript
  #   @return [::Boolean]
  #     Whether the text is a superscript.
  # @!attribute [rw] smallcaps
  #   @return [::Boolean]
  #     Whether the text is in small caps.
  # @!attribute [rw] font_weight
  #   @return [::Integer]
  #     TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy).
  #     Normal is `400`, bold is `700`.
  # @!attribute [rw] handwritten
  #   @return [::Boolean]
  #     Whether the text is handwritten.
  # @!attribute [rw] text_color
  #   @return [::Google::Type::Color]
  #     Color of the text.
  # @!attribute [rw] background_color
  #   @return [::Google::Type::Color]
  #     Color of the background.
  class StyleInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#detected_languages ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>

Returns A list of detected languages together with confidence.

Returns:

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::DetectedLanguage>) —

  A list of detected languages together with confidence.

# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 394

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

  # Detected break at the end of a
  # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak::Type]
  #     Detected break type.
  class DetectedBreak
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to denote the type of break found.
    module Type
      # Unspecified break type.
      TYPE_UNSPECIFIED = 0

      # A single whitespace.
      SPACE = 1

      # A wider whitespace.
      WIDE_SPACE = 2

      # A hyphen that indicates that a token has been split across lines.
      HYPHEN = 3
    end
  end

  # Font and other text style attributes.
  # @!attribute [rw] font_size
  #   @return [::Integer]
  #     Font size in points (`1` point is `¹⁄₇₂` inches).
  # @!attribute [rw] pixel_font_size
  #   @return [::Float]
  #     Font size in pixels, equal to _unrounded
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_size font_size}_
  #     * _resolution_ ÷ `72.0`.
  # @!attribute [rw] letter_spacing
  #   @return [::Float]
  #     Letter spacing in points.
  # @!attribute [rw] font_type
  #   @return [::String]
  #     Name or style of the font.
  # @!attribute [rw] bold
  #   @return [::Boolean]
  #     Whether the text is bold (equivalent to
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_weight font_weight}
  #     is at least `700`).
  # @!attribute [rw] italic
  #   @return [::Boolean]
  #     Whether the text is italic.
  # @!attribute [rw] underlined
  #   @return [::Boolean]
  #     Whether the text is underlined.
  # @!attribute [rw] strikeout
  #   @return [::Boolean]
  #     Whether the text is strikethrough.
  # @!attribute [rw] subscript
  #   @return [::Boolean]
  #     Whether the text is a subscript.
  # @!attribute [rw] superscript
  #   @return [::Boolean]
  #     Whether the text is a superscript.
  # @!attribute [rw] smallcaps
  #   @return [::Boolean]
  #     Whether the text is in small caps.
  # @!attribute [rw] font_weight
  #   @return [::Integer]
  #     TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy).
  #     Normal is `400`, bold is `700`.
  # @!attribute [rw] handwritten
  #   @return [::Boolean]
  #     Whether the text is handwritten.
  # @!attribute [rw] text_color
  #   @return [::Google::Type::Color]
  #     Color of the text.
  # @!attribute [rw] background_color
  #   @return [::Google::Type::Color]
  #     Color of the background.
  class StyleInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#layout ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout

Returns Layout for Token.

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout) —

  Layout for Token.

# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 394

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

  # Detected break at the end of a
  # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak::Type]
  #     Detected break type.
  class DetectedBreak
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to denote the type of break found.
    module Type
      # Unspecified break type.
      TYPE_UNSPECIFIED = 0

      # A single whitespace.
      SPACE = 1

      # A wider whitespace.
      WIDE_SPACE = 2

      # A hyphen that indicates that a token has been split across lines.
      HYPHEN = 3
    end
  end

  # Font and other text style attributes.
  # @!attribute [rw] font_size
  #   @return [::Integer]
  #     Font size in points (`1` point is `¹⁄₇₂` inches).
  # @!attribute [rw] pixel_font_size
  #   @return [::Float]
  #     Font size in pixels, equal to _unrounded
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_size font_size}_
  #     * _resolution_ ÷ `72.0`.
  # @!attribute [rw] letter_spacing
  #   @return [::Float]
  #     Letter spacing in points.
  # @!attribute [rw] font_type
  #   @return [::String]
  #     Name or style of the font.
  # @!attribute [rw] bold
  #   @return [::Boolean]
  #     Whether the text is bold (equivalent to
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_weight font_weight}
  #     is at least `700`).
  # @!attribute [rw] italic
  #   @return [::Boolean]
  #     Whether the text is italic.
  # @!attribute [rw] underlined
  #   @return [::Boolean]
  #     Whether the text is underlined.
  # @!attribute [rw] strikeout
  #   @return [::Boolean]
  #     Whether the text is strikethrough.
  # @!attribute [rw] subscript
  #   @return [::Boolean]
  #     Whether the text is a subscript.
  # @!attribute [rw] superscript
  #   @return [::Boolean]
  #     Whether the text is a superscript.
  # @!attribute [rw] smallcaps
  #   @return [::Boolean]
  #     Whether the text is in small caps.
  # @!attribute [rw] font_weight
  #   @return [::Integer]
  #     TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy).
  #     Normal is `400`, bold is `700`.
  # @!attribute [rw] handwritten
  #   @return [::Boolean]
  #     Whether the text is handwritten.
  # @!attribute [rw] text_color
  #   @return [::Google::Type::Color]
  #     Color of the text.
  # @!attribute [rw] background_color
  #   @return [::Google::Type::Color]
  #     Color of the background.
  class StyleInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#provenance ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Provenance

Returns The history of this annotation.

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::Document::Provenance) —

  The history of this annotation.

# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 394

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

  # Detected break at the end of a
  # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak::Type]
  #     Detected break type.
  class DetectedBreak
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to denote the type of break found.
    module Type
      # Unspecified break type.
      TYPE_UNSPECIFIED = 0

      # A single whitespace.
      SPACE = 1

      # A wider whitespace.
      WIDE_SPACE = 2

      # A hyphen that indicates that a token has been split across lines.
      HYPHEN = 3
    end
  end

  # Font and other text style attributes.
  # @!attribute [rw] font_size
  #   @return [::Integer]
  #     Font size in points (`1` point is `¹⁄₇₂` inches).
  # @!attribute [rw] pixel_font_size
  #   @return [::Float]
  #     Font size in pixels, equal to _unrounded
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_size font_size}_
  #     * _resolution_ ÷ `72.0`.
  # @!attribute [rw] letter_spacing
  #   @return [::Float]
  #     Letter spacing in points.
  # @!attribute [rw] font_type
  #   @return [::String]
  #     Name or style of the font.
  # @!attribute [rw] bold
  #   @return [::Boolean]
  #     Whether the text is bold (equivalent to
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_weight font_weight}
  #     is at least `700`).
  # @!attribute [rw] italic
  #   @return [::Boolean]
  #     Whether the text is italic.
  # @!attribute [rw] underlined
  #   @return [::Boolean]
  #     Whether the text is underlined.
  # @!attribute [rw] strikeout
  #   @return [::Boolean]
  #     Whether the text is strikethrough.
  # @!attribute [rw] subscript
  #   @return [::Boolean]
  #     Whether the text is a subscript.
  # @!attribute [rw] superscript
  #   @return [::Boolean]
  #     Whether the text is a superscript.
  # @!attribute [rw] smallcaps
  #   @return [::Boolean]
  #     Whether the text is in small caps.
  # @!attribute [rw] font_weight
  #   @return [::Integer]
  #     TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy).
  #     Normal is `400`, bold is `700`.
  # @!attribute [rw] handwritten
  #   @return [::Boolean]
  #     Whether the text is handwritten.
  # @!attribute [rw] text_color
  #   @return [::Google::Type::Color]
  #     Color of the text.
  # @!attribute [rw] background_color
  #   @return [::Google::Type::Color]
  #     Color of the background.
  class StyleInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#style_info ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo

Returns Text style attributes.

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo) —

  Text style attributes.

# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 394

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

  # Detected break at the end of a
  # {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token Token}.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::DetectedBreak::Type]
  #     Detected break type.
  class DetectedBreak
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum to denote the type of break found.
    module Type
      # Unspecified break type.
      TYPE_UNSPECIFIED = 0

      # A single whitespace.
      SPACE = 1

      # A wider whitespace.
      WIDE_SPACE = 2

      # A hyphen that indicates that a token has been split across lines.
      HYPHEN = 3
    end
  end

  # Font and other text style attributes.
  # @!attribute [rw] font_size
  #   @return [::Integer]
  #     Font size in points (`1` point is `¹⁄₇₂` inches).
  # @!attribute [rw] pixel_font_size
  #   @return [::Float]
  #     Font size in pixels, equal to _unrounded
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_size font_size}_
  #     * _resolution_ ÷ `72.0`.
  # @!attribute [rw] letter_spacing
  #   @return [::Float]
  #     Letter spacing in points.
  # @!attribute [rw] font_type
  #   @return [::String]
  #     Name or style of the font.
  # @!attribute [rw] bold
  #   @return [::Boolean]
  #     Whether the text is bold (equivalent to
  #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Token::StyleInfo#font_weight font_weight}
  #     is at least `700`).
  # @!attribute [rw] italic
  #   @return [::Boolean]
  #     Whether the text is italic.
  # @!attribute [rw] underlined
  #   @return [::Boolean]
  #     Whether the text is underlined.
  # @!attribute [rw] strikeout
  #   @return [::Boolean]
  #     Whether the text is strikethrough.
  # @!attribute [rw] subscript
  #   @return [::Boolean]
  #     Whether the text is a subscript.
  # @!attribute [rw] superscript
  #   @return [::Boolean]
  #     Whether the text is a superscript.
  # @!attribute [rw] smallcaps
  #   @return [::Boolean]
  #     Whether the text is in small caps.
  # @!attribute [rw] font_weight
  #   @return [::Integer]
  #     TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy).
  #     Normal is `400`, bold is `700`.
  # @!attribute [rw] handwritten
  #   @return [::Boolean]
  #     Whether the text is handwritten.
  # @!attribute [rw] text_color
  #   @return [::Google::Type::Color]
  #     Color of the text.
  # @!attribute [rw] background_color
  #   @return [::Google::Type::Color]
  #     Color of the background.
  class StyleInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end