class Google::Apis::VisionV1::VisionService

Cloud Vision API

The Google Cloud Vision API allows developers to easily integrate Google

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

@example

require 'google/apis/vision_v1'

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

@see cloud.google.com/vision/

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/vision_v1/service.rb, line 48
def initialize
  super('https://vision.googleapis.com/', '')
end

Public Instance Methods

annotate_image(batch_annotate_images_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) click to toggle source

Run image detection and annotation for a batch of images. @param [Google::Apis::VisionV1::BatchAnnotateImagesRequest] batch_annotate_images_request_object @param [String] quota_user

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.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::VisionV1::BatchAnnotateImagesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::VisionV1::BatchAnnotateImagesResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/vision_v1/service.rb, line 71
def annotate_image(batch_annotate_images_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/images:annotate', options)
  command.request_representation = Google::Apis::VisionV1::BatchAnnotateImagesRequest::Representation
  command.request_object = batch_annotate_images_request_object
  command.response_representation = Google::Apis::VisionV1::BatchAnnotateImagesResponse::Representation
  command.response_class = Google::Apis::VisionV1::BatchAnnotateImagesResponse
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/vision_v1/service.rb, line 84
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end