module Google::Cloud::Vision

Constants

VERSION

Public Class Methods

configure() { |configure.vision| ... } click to toggle source

Configure the google-cloud-vision library.

The following configuration parameters are supported:

  • `credentials` (type: `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.

  • `lib_name` (type: `String`) - The library name as recorded in instrumentation and logging.

  • `lib_version` (type: `String`) - The library version as recorded in instrumentation and logging.

  • `interceptors` (type: `Array<GRPC::ClientInterceptor>`) - An array of interceptors that are run before calls are executed.

  • `timeout` (type: `Numeric`) - Default timeout in seconds.

  • `metadata` (type: `Hash{Symbol=>String}`) - Additional gRPC headers to be sent with the call.

  • `retry_policy` (type: `Hash`) - The retry policy. The value is a hash with the following keys:

    * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
    * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
    * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
    * `:retry_codes` (*type:* `Array<String>`) -
      The error codes that should trigger a retry.

@return [::Google::Cloud::Config] The default configuration used by this library

# File lib/google/cloud/vision.rb, line 150
def self.configure
  yield ::Google::Cloud.configure.vision if block_given?

  ::Google::Cloud.configure.vision
end
image_annotator(version: :v1, &block) click to toggle source

Create a new client object for ImageAnnotator.

By default, this returns an instance of [Google::Cloud::Vision::V1::ImageAnnotator::Client](googleapis.dev/ruby/google-cloud-vision-v1/latest/Google/Cloud/Vision/V1/ImageAnnotator/Client.html) for version V1 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the ImageAnnotator service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

## About ImageAnnotator

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.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v1`.

@return [ImageAnnotator::Client] A client object for the specified version.

# File lib/google/cloud/vision.rb, line 111
def self.image_annotator version: :v1, &block
  require "google/cloud/vision/#{version.to_s.downcase}"

  package_name = Google::Cloud::Vision
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Vision.const_get package_name
  package_module.const_get(:ImageAnnotator).const_get(:Client).new(&block)
end