Class: Google::Cloud::Vision::V1::ImageAnnotator::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/vision/v1/image_annotator/client.rb,
lib/google/cloud/vision/v1/image_annotator/helpers.rb

Overview

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.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#product_set_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ImageAnnotator client object.

Examples

To create a new ImageAnnotator client with the default configuration:

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

To create a new ImageAnnotator client with a custom configuration:

client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the ImageAnnotator client.

Yield Parameters:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/google/cloud/vision/v1/image_annotator/client.rb', line 148

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/vision/v1/image_annotator_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(String) || credentials.is_a?(Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.endpoint = @config.endpoint
  end

  @image_annotator_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Vision::V1::ImageAnnotator::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#operations_client::Google::Cloud::Vision::V1::ImageAnnotator::Operations (readonly)

Get the associated client for long-running operations.



189
190
191
# File 'lib/google/cloud/vision/v1/image_annotator/client.rb', line 189

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ImageAnnotator Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all ImageAnnotator clients:

::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/google/cloud/vision/v1/image_annotator/client.rb', line 59

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Vision", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const&.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.batch_annotate_images.timeout = 600.0
    default_config.rpcs.batch_annotate_images.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
    }

    default_config.rpcs.batch_annotate_files.timeout = 600.0
    default_config.rpcs.batch_annotate_files.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
    }

    default_config.rpcs.async_batch_annotate_images.timeout = 600.0
    default_config.rpcs.async_batch_annotate_images.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
    }

    default_config.rpcs.async_batch_annotate_files.timeout = 600.0
    default_config.rpcs.async_batch_annotate_files.retry_policy = {
      initial_delay: 0.1,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#async_batch_annotate_files(request, options = nil) ⇒ ::Gapic::Operation #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:

  • #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) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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>) (defaults to: nil)

      Required. Individual async file annotation requests for this batch.

    • parent (::String) (defaults to: nil)

      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.



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
# File 'lib/google/cloud/vision/v1/image_annotator/client.rb', line 477

def async_batch_annotate_files request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.async_batch_annotate_files..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Vision::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.async_batch_annotate_files.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.async_batch_annotate_files.retry_policy
  options.apply_defaults metadata:     @config.,
                         retry_policy: @config.retry_policy

  @image_annotator_stub.call_rpc :async_batch_annotate_files, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#async_batch_annotate_images(request, options = nil) ⇒ ::Gapic::Operation #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:

  • #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) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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>) (defaults to: nil)

      Required. Individual image annotation requests for this batch.

    • output_config (::Google::Cloud::Vision::V1::OutputConfig, ::Hash) (defaults to: nil)

      Required. The desired output location and metadata (e.g. format).

    • parent (::String) (defaults to: nil)

      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.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/google/cloud/vision/v1/image_annotator/client.rb', line 398

def async_batch_annotate_images request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.async_batch_annotate_images..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Vision::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.async_batch_annotate_images.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.async_batch_annotate_images.retry_policy
  options.apply_defaults metadata:     @config.,
                         retry_policy: @config.retry_policy

  @image_annotator_stub.call_rpc :async_batch_annotate_images, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_annotate_files(request, options = nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse #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:

  • #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) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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>) (defaults to: nil)

      Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

    • parent (::String) (defaults to: nil)

      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.



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/google/cloud/vision/v1/image_annotator/client.rb', line 315

def batch_annotate_files request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Vision::V1::BatchAnnotateFilesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.batch_annotate_files..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Vision::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_annotate_files.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.batch_annotate_files.retry_policy
  options.apply_defaults metadata:     @config.,
                         retry_policy: @config.retry_policy

  @image_annotator_stub.call_rpc :batch_annotate_files, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_annotate_images(request, options = nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse #batch_annotate_images(requests: nil, parent: nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse

Run image detection and annotation for a batch of images.

Overloads:

  • #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) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #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>) (defaults to: nil)

      Required. Individual image annotation requests for this batch.

    • parent (::String) (defaults to: nil)

      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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/google/cloud/vision/v1/image_annotator/client.rb', line 235

def batch_annotate_images request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Vision::V1::BatchAnnotateImagesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.batch_annotate_images..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Vision::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.batch_annotate_images.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.batch_annotate_images.retry_policy
  options.apply_defaults metadata:     @config.,
                         retry_policy: @config.retry_policy

  @image_annotator_stub.call_rpc :batch_annotate_images, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

See Configuration for a description of the configuration fields.

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



123
124
125
126
# File 'lib/google/cloud/vision/v1/image_annotator/client.rb', line 123

def configure
  yield @config if block_given?
  @config
end

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

Detect features of type CROP_HINTS.

Examples:

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

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.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 73

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

  feature = { type: :CROP_HINTS, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type DOCUMENT_TEXT_DETECTION.

Examples:

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

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.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 171

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

  feature = { type: :DOCUMENT_TEXT_DETECTION, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type FACE_DETECTION.

Examples:

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

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.



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 269

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

  feature = { type: :FACE_DETECTION, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type IMAGE_PROPERTIES.

Examples:

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

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.



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 367

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

  feature = { type: :IMAGE_PROPERTIES, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type LABEL_DETECTION.

Examples:

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

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.



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 465

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

  feature = { type: :LABEL_DETECTION, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type LANDMARK_DETECTION.

Examples:

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

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.



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 563

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

  feature = { type: :LANDMARK_DETECTION, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type LOGO_DETECTION.

Examples:

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

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.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 661

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

  feature = { type: :LOGO_DETECTION, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type OBJECT_LOCALIZATION.

Examples:

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

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.



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 759

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

  feature = { type: :OBJECT_LOCALIZATION, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type PRODUCT_SEARCH.

Examples:

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

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.



857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 857

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

  feature = { type: :PRODUCT_SEARCH, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type SAFE_SEARCH_DETECTION.

Examples:

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

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.



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 955

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

  feature = { type: :SAFE_SEARCH_DETECTION, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type TEXT_DETECTION.

Examples:

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

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.



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 1053

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

  feature = { type: :TEXT_DETECTION, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end

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

Detect features of type WEB_DETECTION.

Examples:

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

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.



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'lib/google/cloud/vision/v1/image_annotator/helpers.rb', line 1151

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

  feature = { type: :WEB_DETECTION, max_results: max_results }
  images << image if image
  formatted_images = images.map do |img|
    formatted_image = normalize_image img
    formatted_image[:mime_type] = mime_type if mime_type
    formatted_image
  end
  requests = formatted_images.map do |img|
    request = { image: img, features: [feature] }
    request[:image_context] = image_context if image_context
    request
  end
  batch_request = { requests: requests }

  if async
    requests.map! do |request|
      {
        input_config:  {
          gcs_source: {
            uri: request[:image][:source][:gcs_image_uri]
          },
          mime_type:  mime_type
        },
        features:      request[:features],
        output_config: {
          gcs_destination: {
            uri: destination
          },
          batch_size:      batch_size
        }
      }
    end
    async_batch_annotate_files batch_request, options, &block
  else
    batch_annotate_images batch_request, options, &block
  end
end