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.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the AutoML service.
You can determine whether the method will succeed by calling
AutoML.automl_available?.
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.
Determines whether the AutoML service is supported by the current client.
If true, you can retrieve a client object by calling AutoML.automl.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the AutoML service,
or if the versioned client gem needs an update to support the AutoML service.
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
(boolean) — Whether the service is available.
.configure
defself.configure()->::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
(::Google::Cloud.configure.automl)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
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.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the PredictionService service.
You can determine whether the method will succeed by calling
AutoML.prediction_service_available?.
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.
Determines whether the PredictionService service is supported by the current client.
If true, you can retrieve a client object by calling AutoML.prediction_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the PredictionService service,
or if the versioned client gem needs an update to support the PredictionService service.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud AutoML API - Module Google::Cloud::AutoML (v2.0.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.2 (latest)](/ruby/docs/reference/google-cloud-automl/latest/Google-Cloud-AutoML)\n- [2.0.1](/ruby/docs/reference/google-cloud-automl/2.0.1/Google-Cloud-AutoML)\n- [1.6.0](/ruby/docs/reference/google-cloud-automl/1.6.0/Google-Cloud-AutoML)\n- [1.5.0](/ruby/docs/reference/google-cloud-automl/1.5.0/Google-Cloud-AutoML)\n- [1.4.0](/ruby/docs/reference/google-cloud-automl/1.4.0/Google-Cloud-AutoML)\n- [1.3.0](/ruby/docs/reference/google-cloud-automl/1.3.0/Google-Cloud-AutoML)\n- [1.2.0](/ruby/docs/reference/google-cloud-automl/1.2.0/Google-Cloud-AutoML)\n- [1.1.4](/ruby/docs/reference/google-cloud-automl/1.1.4/Google-Cloud-AutoML) \nReference documentation and code samples for the Cloud AutoML API module Google::Cloud::AutoML.\n\nMethods\n-------\n\n### .automl\n\n def self.automl(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for AutoML.\n\n\nBy default, this returns an instance of\n[Google::Cloud::AutoML::V1::AutoML::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-automl-v1/latest/Google-Cloud-AutoML-V1-AutoML-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the AutoML service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the AutoML service.\nYou can determine whether the method will succeed by calling\n[AutoML.automl_available?](/ruby/docs/reference/google-cloud-automl/latest/Google-Cloud-AutoML#Google__Cloud__AutoML_automl_available__class_ \"Google::Cloud::AutoML.automl_available? (method)\").\n\n#### About AutoML\n\nAutoML Server API.\n\nThe resource names are assigned by the server.\nThe server never reuses names that it has created after the resources with\nthose names are deleted.\n\nAn ID of a resource is the last element of the item's resource name. For\n`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`, then\nthe id for the item is `{dataset_id}`.\n\nCurrently the only supported `location_id` is \"us-central1\".\n\n\u003cbr /\u003e\n\nOn any input that is documented to expect a string parameter in\nsnake_case or dash-case, either of those cases is accepted. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .automl_available?\n\n def self.automl_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the AutoML service is supported by the current client.\nIf true, you can retrieve a client object by calling [AutoML.automl](/ruby/docs/reference/google-cloud-automl/latest/Google-Cloud-AutoML#Google__Cloud__AutoML_automl_class_ \"Google::Cloud::AutoML.automl (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the AutoML service,\nor if the versioned client gem needs an update to support the AutoML service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-automl library.\n\nThe following configuration parameters are supported:\n\n- `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.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.automl) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .prediction_service\n\n def self.prediction_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for PredictionService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::AutoML::V1::PredictionService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-automl-v1/latest/Google-Cloud-AutoML-V1-PredictionService-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the PredictionService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the PredictionService service.\nYou can determine whether the method will succeed by calling\n[AutoML.prediction_service_available?](/ruby/docs/reference/google-cloud-automl/latest/Google-Cloud-AutoML#Google__Cloud__AutoML_prediction_service_available__class_ \"Google::Cloud::AutoML.prediction_service_available? (method)\").\n\n#### About PredictionService\n\nAutoML Prediction API.\n\n\u003cbr /\u003e\n\nOn any input that is documented to expect a string parameter in\nsnake_case or dash-case, either of those cases is accepted. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .prediction_service_available?\n\n def self.prediction_service_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the PredictionService service is supported by the current client.\nIf true, you can retrieve a client object by calling [AutoML.prediction_service](/ruby/docs/reference/google-cloud-automl/latest/Google-Cloud-AutoML#Google__Cloud__AutoML_prediction_service_class_ \"Google::Cloud::AutoML.prediction_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the PredictionService service,\nor if the versioned client gem needs an update to support the PredictionService service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### #auto_ml\n\n def auto_ml()\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"2.0.2\""]]