Class: Google::Apis::VisionV1p1beta1::VisionService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/vision_v1p1beta1/service.rb

Overview

Cloud Vision API

Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.

Examples:

require 'google/apis/vision_v1p1beta1'

Vision = Google::Apis::VisionV1p1beta1 # Alias the module
service = Vision::VisionService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ VisionService

Returns a new instance of VisionService.



47
48
49
50
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 47

def initialize
  super('https://vision.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#annotate_file(google_cloud_vision_v1p1beta1_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse

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.

Parameters:

  • google_cloud_vision_v1p1beta1_batch_annotate_files_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



76
77
78
79
80
81
82
83
84
85
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 76

def annotate_file(google_cloud_vision_v1p1beta1_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/files:annotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_batch_annotate_files_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#annotate_image(google_cloud_vision_v1p1beta1_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse

Run image detection and annotation for a batch of images.

Parameters:

  • google_cloud_vision_v1p1beta1_batch_annotate_images_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



141
142
143
144
145
146
147
148
149
150
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 141

def annotate_image(google_cloud_vision_v1p1beta1_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/images:annotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_batch_annotate_images_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#annotate_project_file(parent, google_cloud_vision_v1p1beta1_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse

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.

Parameters:

  • 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`.

  • google_cloud_vision_v1p1beta1_batch_annotate_files_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



221
222
223
224
225
226
227
228
229
230
231
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 221

def annotate_project_file(parent, google_cloud_vision_v1p1beta1_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/{+parent}/files:annotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_batch_annotate_files_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#annotate_project_image(parent, google_cloud_vision_v1p1beta1_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse

Run image detection and annotation for a batch of images.

Parameters:

  • 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`.

  • google_cloud_vision_v1p1beta1_batch_annotate_images_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



306
307
308
309
310
311
312
313
314
315
316
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 306

def annotate_project_image(parent, google_cloud_vision_v1p1beta1_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/{+parent}/images:annotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_batch_annotate_images_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#annotate_project_location_file(parent, google_cloud_vision_v1p1beta1_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse

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.

Parameters:

  • 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`.

  • google_cloud_vision_v1p1beta1_batch_annotate_files_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



397
398
399
400
401
402
403
404
405
406
407
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 397

def annotate_project_location_file(parent, google_cloud_vision_v1p1beta1_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/{+parent}/files:annotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_batch_annotate_files_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#annotate_project_location_image(parent, google_cloud_vision_v1p1beta1_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse

Run image detection and annotation for a batch of images.

Parameters:

  • 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`.

  • google_cloud_vision_v1p1beta1_batch_annotate_images_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



482
483
484
485
486
487
488
489
490
491
492
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 482

def annotate_project_location_image(parent, google_cloud_vision_v1p1beta1_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/{+parent}/images:annotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_batch_annotate_images_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#async_file_batch_annotate(google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::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).

Parameters:

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



111
112
113
114
115
116
117
118
119
120
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 111

def async_file_batch_annotate(google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/files:asyncBatchAnnotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::Operation::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#async_image_batch_annotate(google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::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.

Parameters:

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



177
178
179
180
181
182
183
184
185
186
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 177

def async_image_batch_annotate(google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/images:asyncBatchAnnotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::Operation::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#async_project_file_batch_annotate(parent, google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::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).

Parameters:

  • 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`.

  • google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



266
267
268
269
270
271
272
273
274
275
276
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 266

def async_project_file_batch_annotate(parent, google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/{+parent}/files:asyncBatchAnnotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::Operation::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#async_project_image_batch_annotate(parent, google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::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.

Parameters:

  • 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`.

  • google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



352
353
354
355
356
357
358
359
360
361
362
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 352

def async_project_image_batch_annotate(parent, google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/{+parent}/images:asyncBatchAnnotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::Operation::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#async_project_location_file_batch_annotate(parent, google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::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).

Parameters:

  • 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`.

  • google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



442
443
444
445
446
447
448
449
450
451
452
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 442

def async_project_location_file_batch_annotate(parent, google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/{+parent}/files:asyncBatchAnnotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::Operation::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#async_project_location_image_batch_annotate(parent, google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VisionV1p1beta1::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.

Parameters:

  • 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`.

  • google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object (Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



528
529
530
531
532
533
534
535
536
537
538
 
# File 'generated/google/apis/vision_v1p1beta1/service.rb', line 528

def async_project_location_image_batch_annotate(parent, google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/{+parent}/images:asyncBatchAnnotate', options)
  command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest::Representation
  command.request_object = google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object
  command.response_representation = Google::Apis::VisionV1p1beta1::Operation::Representation
  command.response_class = Google::Apis::VisionV1p1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end