Class: Google::Cloud::Vision::V1::AnnotateFileRequest

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

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#features ⇒ ::Array<::Google::Cloud::Vision::V1::Feature>

Returns Required. Requested features.

Returns:



752
753
754
755
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 752

class AnnotateFileRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#image_context ⇒ ::Google::Cloud::Vision::V1::ImageContext

Returns Additional context that may accompany the image(s) in the file.

Returns:



752
753
754
755
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 752

class AnnotateFileRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#input_config ⇒ ::Google::Cloud::Vision::V1::InputConfig

Returns Required. Information about the input file.

Returns:



752
753
754
755
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 752

class AnnotateFileRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pages ⇒ ::Array<::Integer>

Returns 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.

Returns:

  • (::Array<::Integer>) —

    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.



752
753
754
755
 
# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 752

class AnnotateFileRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end