Module: Google::Cloud::AutoML

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

Constant Summary collapse

VERSION = 
"1.5.0"

Class Method Summary collapse

Class Method Details

.automl(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for AutoML.

By default, this returns an instance of Google::Cloud::AutoML::V1::AutoML::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

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 dash-case, either of those cases is accepted.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/automl.rb', line 120

def self.automl version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::AutoML.const_get(package_name).const_get(:AutoML)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.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 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



160
161
162
163
164
 
# File 'lib/google/cloud/automl.rb', line 160

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

  ::Google::Cloud.configure.automl
end

.prediction_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for PredictionService.

By default, this returns an instance of Google::Cloud::AutoML::V1::PredictionService::Client for a gRPC client for version V1 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About PredictionService

AutoML Prediction API.

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

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/cloud/automl.rb', line 73

def self.prediction_service version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::AutoML.const_get(package_name).const_get(:PredictionService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end