Class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AnnotateFileRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/vision_v1p1beta1/classes.rb,
generated/google/apis/vision_v1p1beta1/representations.rb,
generated/google/apis/vision_v1p1beta1/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

Constructor Details

#initialize(**args) ⇒ GoogleCloudVisionV1p1beta1AnnotateFileRequest

Returns a new instance of GoogleCloudVisionV1p1beta1AnnotateFileRequest.



917
918
919
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 917

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

Instance Attribute Details

#features ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Feature>

Required. Requested features. Corresponds to the JSON property features

Returns:



894
895
896
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 894

def features
  @features
end

#image_context ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageContext

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

Returns:



899
900
901
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 899

def image_context
  @image_context
end

#input_config ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1InputConfig

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

Returns:



904
905
906
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 904

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


915
916
917
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 915

def pages
  @pages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



922
923
924
925
926
927
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 922

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