Cloud Vision V1 API - Class Google::Cloud::Vision::V1::AnnotateFileRequest (v0.14.0)

Reference documentation and code samples for the Cloud Vision V1 API class Google::Cloud::Vision::V1::AnnotateFileRequest.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#features

def features() -> ::Array<::Google::Cloud::Vision::V1::Feature>
Returns

#features=

def features=(value) -> ::Array<::Google::Cloud::Vision::V1::Feature>
Parameter
Returns

#image_context

def image_context() -> ::Google::Cloud::Vision::V1::ImageContext
Returns

#image_context=

def image_context=(value) -> ::Google::Cloud::Vision::V1::ImageContext
Parameter
Returns

#input_config

def input_config() -> ::Google::Cloud::Vision::V1::InputConfig
Returns

#input_config=

def input_config=(value) -> ::Google::Cloud::Vision::V1::InputConfig
Parameter
Returns

#pages

def pages() -> ::Array<::Integer>
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.

#pages=

def pages=(value) -> ::Array<::Integer>
Parameter
  • value (::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.

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.