Class: Google::Apis::VisionV1::AnnotateFileRequest

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

A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

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

Returns a new instance of AnnotateFileRequest.



79
80
81
 
# File 'generated/google/apis/vision_v1/classes.rb', line 79

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

Instance Attribute Details

#features ⇒ Array<Google::Apis::VisionV1::Feature>

Required. Requested features. Corresponds to the JSON property features

Returns:



53
54
55
 
# File 'generated/google/apis/vision_v1/classes.rb', line 53

def features
  @features
end

#image_context ⇒ Google::Apis::VisionV1::ImageContext

Image context and/or feature-specific parameters. Corresponds to the JSON property imageContext

Returns:



58
59
60
 
# File 'generated/google/apis/vision_v1/classes.rb', line 58

def image_context
  @image_context
end

#input_config ⇒ Google::Apis::VisionV1::InputConfig

The desired input location and metadata. Corresponds to the JSON property inputConfig

Returns:



63
64
65
 
# File 'generated/google/apis/vision_v1/classes.rb', line 63

def input_config
  @input_config
end

#pages ⇒ Array<Fixnum>

Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file. Corresponds to the JSON property pages

Returns:

  • (Array<Fixnum>) 


77
78
79
 
# File 'generated/google/apis/vision_v1/classes.rb', line 77

def pages
  @pages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



84
85
86
87
88
89
 
# File 'generated/google/apis/vision_v1/classes.rb', line 84

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