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

Version 0.8.0

• 1.1.0 (latest)
• 1.0.1
• 0.15.0
• 0.14.0
• 0.13.2
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.4

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

• (::Array<::Google::Cloud::Vision::V1::Feature>) — Required. Requested features.

#features=

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

Parameter

• value (::Array<::Google::Cloud::Vision::V1::Feature>) — Required. Requested features.

Returns

• (::Array<::Google::Cloud::Vision::V1::Feature>) — Required. Requested features.

#image_context

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

Returns

• (::Google::Cloud::Vision::V1::ImageContext) — Additional context that may accompany the image(s) in the file.

#image_context=

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

Parameter

• value (::Google::Cloud::Vision::V1::ImageContext) — Additional context that may accompany the image(s) in the file.

Returns

• (::Google::Cloud::Vision::V1::ImageContext) — Additional context that may accompany the image(s) in the file.

#input_config

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

Returns

• (::Google::Cloud::Vision::V1::InputConfig) — Required. Information about the input file.

#input_config=

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

Parameter

• value (::Google::Cloud::Vision::V1::InputConfig) — Required. Information about the input file.

Returns

• (::Google::Cloud::Vision::V1::InputConfig) — Required. Information about the input file.

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