Module: Google::Cloud::AutoML

Defined in:
lib/google/cloud/automl.rb,
lib/google/cloud/automl/version.rb

Constant Summary collapse

VERSION =
"1.1.0"

Class Method Summary collapse

Class Method Details

.auto_ml(version: :v1, &block) ⇒ AutoML::Client

Create a new client object for AutoML.

By default, this returns an instance of Google::Cloud::AutoML::V1::AutoML::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the AutoML service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About AutoML

AutoML Server API.

The resource names are assigned by the server. The server never reuses names that it has created after the resources with those names are deleted.

An ID of a resource is the last element of the item's resource name. For projects/{project_id}/locations/{location_id}/datasets/{dataset_id}, then the id for the item is {dataset_id}.

Currently the only supported location_id is "us-central1".

On any input that is documented to expect a string parameter in snake_case or kebab-case, either of those cases is accepted.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (AutoML::Client)

    A client object for the specified version.



112
113
114
115
116
117
118
119
120
121
# File 'lib/google/cloud/automl.rb', line 112

def self.auto_ml version: :v1, &block
  require "google/cloud/automl/#{version.to_s.downcase}"

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

.configure {|::Google::Cloud.configure.automl| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-automl 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.

Yields:

Returns:

  • (::Google::Cloud::Config)

    The default configuration used by this library



151
152
153
154
155
# File 'lib/google/cloud/automl.rb', line 151

def self.configure
  yield ::Google::Cloud.configure.automl if block_given?

  ::Google::Cloud.configure.automl
end

.prediction_service(version: :v1, &block) ⇒ PredictionService::Client

Create a new client object for PredictionService.

By default, this returns an instance of Google::Cloud::AutoML::V1::PredictionService::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the PredictionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About PredictionService

AutoML Prediction API.

On any input that is documented to expect a string parameter in snake_case or kebab-case, either of those cases is accepted.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (PredictionService::Client)

    A client object for the specified version.



69
70
71
72
73
74
75
76
77
78
# File 'lib/google/cloud/automl.rb', line 69

def self.prediction_service version: :v1, &block
  require "google/cloud/automl/#{version.to_s.downcase}"

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