Cloud Vision V1 API - Class Google::Cloud::Vision::V1::ImageAnnotator::Client (v0.9.0)

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

Client for the ImageAnnotator service.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ImageAnnotator Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all ImageAnnotator clients
::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
  config.timeout = 10.0
end

#async_batch_annotate_files

def async_batch_annotate_files(request, options = nil) -> ::Gapic::Operation
def async_batch_annotate_files(requests: nil, parent: nil) -> ::Gapic::Operation

Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateFilesResponse (results).

Overloads 
def async_batch_annotate_files(request, options = nil) -> ::Gapic::Operation
Pass arguments to async_batch_annotate_files via a request object, either of type AsyncBatchAnnotateFilesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def async_batch_annotate_files(requests: nil, parent: nil) -> ::Gapic::Operation
Pass arguments to async_batch_annotate_files via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • requests (::Array<::Google::Cloud::Vision::V1::AsyncAnnotateFileRequest, ::Hash>) — Required. Individual async file annotation requests for this batch.
  • parent (::String) — Optional. Target project and location to make a call.

    Format: projects/{project-id}/locations/{location-id}.

    If no parent is specified, a region will be chosen automatically.

    Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

    Example: projects/project-A/locations/eu.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest.new

# Call the async_batch_annotate_files method.
result = client.async_batch_annotate_files request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#async_batch_annotate_images

def async_batch_annotate_images(request, options = nil) -> ::Gapic::Operation
def async_batch_annotate_images(requests: nil, output_config: nil, parent: nil) -> ::Gapic::Operation

Run asynchronous image detection and annotation for a list of images.

Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateImagesResponse (results).

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Overloads 
def async_batch_annotate_images(request, options = nil) -> ::Gapic::Operation
Pass arguments to async_batch_annotate_images via a request object, either of type AsyncBatchAnnotateImagesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def async_batch_annotate_images(requests: nil, output_config: nil, parent: nil) -> ::Gapic::Operation
Pass arguments to async_batch_annotate_images via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • requests (::Array<::Google::Cloud::Vision::V1::AnnotateImageRequest, ::Hash>) — Required. Individual image annotation requests for this batch.
  • output_config (::Google::Cloud::Vision::V1::OutputConfig, ::Hash) — Required. The desired output location and metadata (e.g. format).
  • parent (::String) — Optional. Target project and location to make a call.

    Format: projects/{project-id}/locations/{location-id}.

    If no parent is specified, a region will be chosen automatically.

    Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

    Example: projects/project-A/locations/eu.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest.new

# Call the async_batch_annotate_images method.
result = client.async_batch_annotate_images request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#batch_annotate_files

def batch_annotate_files(request, options = nil) -> ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse
def batch_annotate_files(requests: nil, parent: nil) -> ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

Overloads 
def batch_annotate_files(request, options = nil) -> ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse
Pass arguments to batch_annotate_files via a request object, either of type BatchAnnotateFilesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Vision::V1::BatchAnnotateFilesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def batch_annotate_files(requests: nil, parent: nil) -> ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse
Pass arguments to batch_annotate_files via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • requests (::Array<::Google::Cloud::Vision::V1::AnnotateFileRequest, ::Hash>) — Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.
  • parent (::String) — Optional. Target project and location to make a call.

    Format: projects/{project-id}/locations/{location-id}.

    If no parent is specified, a region will be chosen automatically.

    Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

    Example: projects/project-A/locations/eu.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Vision::V1::BatchAnnotateFilesRequest.new

# Call the batch_annotate_files method.
result = client.batch_annotate_files request

# The returned object is of type Google::Cloud::Vision::V1::BatchAnnotateFilesResponse.
p result

#batch_annotate_images

def batch_annotate_images(request, options = nil) -> ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse
def batch_annotate_images(requests: nil, parent: nil) -> ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse

Run image detection and annotation for a batch of images.

Overloads 
def batch_annotate_images(request, options = nil) -> ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse
Pass arguments to batch_annotate_images via a request object, either of type BatchAnnotateImagesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Vision::V1::BatchAnnotateImagesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def batch_annotate_images(requests: nil, parent: nil) -> ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse
Pass arguments to batch_annotate_images via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • requests (::Array<::Google::Cloud::Vision::V1::AnnotateImageRequest, ::Hash>) — Required. Individual image annotation requests for this batch.
  • parent (::String) — Optional. Target project and location to make a call.

    Format: projects/{project-id}/locations/{location-id}.

    If no parent is specified, a region will be chosen automatically.

    Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

    Example: projects/project-A/locations/eu.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Vision::V1::BatchAnnotateImagesRequest.new

# Call the batch_annotate_images method.
result = client.batch_annotate_images request

# The returned object is of type Google::Cloud::Vision::V1::BatchAnnotateImagesResponse.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ImageAnnotator Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#crop_hints_detection

def crop_hints_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type CROP_HINTS.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.crop_hints_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#document_text_detection

def document_text_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type DOCUMENT_TEXT_DETECTION.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.document_text_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#face_detection

def face_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type FACE_DETECTION.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.face_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#image_properties_detection

def image_properties_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type IMAGE_PROPERTIES.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.image_properties_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#initialize

def initialize() { |config| ... } -> Client

Create a new ImageAnnotator client object.

Yields
  • (config) — Configure the ImageAnnotator client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
  config.timeout = 10.0
end

#label_detection

def label_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type LABEL_DETECTION.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.label_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#landmark_detection

def landmark_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type LANDMARK_DETECTION.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.landmark_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#logo_detection

def logo_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type LOGO_DETECTION.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.logo_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#object_localization_detection

def object_localization_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type OBJECT_LOCALIZATION.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.object_localization_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#operations_client

def operations_client() -> ::Google::Cloud::Vision::V1::ImageAnnotator::Operations

Get the associated client for long-running operations.

Returns

#product_search_detection

def product_search_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type PRODUCT_SEARCH.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.product_search_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#safe_search_detection

def safe_search_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type SAFE_SEARCH_DETECTION.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.safe_search_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#text_detection

def text_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type TEXT_DETECTION.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.text_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end

#web_detection

def web_detection(images: [], image: nil, max_results: 10, options: nil, async: false, mime_type: nil, batch_size: 10, destination: nil, image_context: nil, &block) { |result, operation| ... } -> Google::Cloud::Vision::V1::BatchAnnotateImagesResponse, Gapic::Operation

Detect features of type WEB_DETECTION.

Parameters
  • images (Array<String>, Array<File>) (defaults to: []) — An array containing files, file paths, io objects, image urls, or Google Cloud Storage urls. Can be used with or instead of image.
  • image (File, String) (defaults to: nil) — A file, file path, io object, url pointing to an image, or Google Cloud Storage url. Can be used with or instead of images.
  • max_results (Integer) (defaults to: 10) — Optional. Defaults to 10.
  • options (Gapic::CallOptions) (defaults to: nil) — Optional. Overrides the default settings for this call, e.g, timeout, retries, etc.
  • async (Boolean) (defaults to: false) — Optional. Defaults to false. If false, performs the request synchronously, returning a BatchAnnotateImagesResponse. If true, performs the request asynchronously, returning a Gapic::Operation.
  • mime_type (String) (defaults to: nil) — Required only if async is true.
  • batch_size (Integer) (defaults to: 10) — Optional. Defaults to 10. When async is true, this specifies the number of input files per output json.
  • destination (String) (defaults to: nil) — A Google Cloud Storage location for storing the output. Required only if async is true.
  • image_context (Hash) (defaults to: nil) — Optional. Image context and/or feature-specific parameters.
Yields
  • (result, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (Google::Cloud::Error) — if the RPC is aborted.
Example 
require "google/cloud/vision/v1"

image_annotator_client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new

response = image_annotator_client.web_detection image: "path/to/image.png"
response.responses.each do |res|
  puts res
end