Class: Google::Apis::VisionV1::TextAnnotation

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

Overview

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ TextAnnotation

Returns a new instance of TextAnnotation



3685
3686
3687
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3685

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

Instance Attribute Details

#pages ⇒ Array<Google::Apis::VisionV1::Page>

List of pages detected by OCR. Corresponds to the JSON property pages

Returns:



3678
3679
3680
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3678

def pages
  @pages
end

#text ⇒ String

UTF-8 text detected on the pages. Corresponds to the JSON property text

Returns:

  • (String) 


3683
3684
3685
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3683

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3690
3691
3692
3693
 
# File 'generated/google/apis/vision_v1/classes.rb', line 3690

def update!(**args)
  @pages = args[:pages] if args.key?(:pages)
  @text = args[:text] if args.key?(:text)
end