Cloud AutoML V1beta1 API - Class Google::Cloud::AutoML::V1beta1::PredictionService::Rest::Client (v0.10.2)

Reference documentation and code samples for the Cloud AutoML V1beta1 API class Google::Cloud::AutoML::V1beta1::PredictionService::Rest::Client.

REST client for the PredictionService service.

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.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the PredictionService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all PredictionService clients
::Google::Cloud::AutoML::V1beta1::PredictionService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#batch_predict

def batch_predict(request, options = nil) -> ::Gapic::Operation
def batch_predict(name: nil, input_config: nil, output_config: nil, params: nil) -> ::Gapic::Operation

Perform a batch prediction. Unlike the online Predict, batch prediction result won't be immediately available in the response. Instead, a long running operation object is returned. User can poll the operation result via GetOperation method. Once the operation is done, BatchPredictResult is returned in the response field. Available for following ML problems:

  • Image Classification
  • Image Object Detection
  • Video Classification
  • Video Object Tracking * Text Extraction
  • Tables
Overloads 
def batch_predict(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_predict via a request object, either of type BatchPredictRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AutoML::V1beta1::BatchPredictRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def batch_predict(name: nil, input_config: nil, output_config: nil, params: nil) -> ::Gapic::Operation
Pass arguments to batch_predict via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the model requested to serve the batch prediction.
  • input_config (::Google::Cloud::AutoML::V1beta1::BatchPredictInputConfig, ::Hash) — Required. The input configuration for batch prediction.
  • output_config (::Google::Cloud::AutoML::V1beta1::BatchPredictOutputConfig, ::Hash) — Required. The Configuration specifying where output predictions should be written.
  • params (::Hash{::String => ::String}) — Required. Additional domain-specific parameters for the predictions, any string must be up to 25000 characters long.

    • For Text Classification:

    score_threshold - (float) A value from 0.0 to 1.0. When the model makes predictions for a text snippet, it will only produce results that have at least this confidence score. The default is 0.5.

    • For Image Classification:

    score_threshold - (float) A value from 0.0 to 1.0. When the model makes predictions for an image, it will only produce results that have at least this confidence score. The default is 0.5.

    • For Image Object Detection:

    score_threshold - (float) When Model detects objects on the image, it will only produce bounding boxes which have at least this confidence score. Value in 0 to 1 range, default is 0.5. max_bounding_box_count - (int64) No more than this number of bounding boxes will be produced per image. Default is 100, the requested value may be limited by server.

    • For Video Classification :

    score_threshold - (float) A value from 0.0 to 1.0. When the model makes predictions for a video, it will only produce results that have at least this confidence score. The default is 0.5. segment_classification - (boolean) Set to true to request segment-level classification. AutoML Video Intelligence returns labels and their confidence scores for the entire segment of the video that user specified in the request configuration. The default is "true". shot_classification - (boolean) Set to true to request shot-level classification. AutoML Video Intelligence determines the boundaries for each camera shot in the entire segment of the video that user specified in the request configuration. AutoML Video Intelligence then returns labels and their confidence scores for each detected shot, along with the start and end time of the shot. WARNING: Model evaluation is not done for this classification type, the quality of it depends on training data, but there are no metrics provided to describe that quality. The default is "false". 1s_interval_classification - (boolean) Set to true to request classification for a video at one-second intervals. AutoML Video Intelligence returns labels and their confidence scores for each second of the entire segment of the video that user specified in the request configuration. WARNING: Model evaluation is not done for this classification type, the quality of it depends on training data, but there are no metrics provided to describe that quality. The default is "false".

    • For Tables:

    feature_importance - (boolean) Whether feature importance should be populated in the returned TablesAnnotations. The default is false.

    • For Video Object Tracking:

    score_threshold - (float) When Model detects objects on video frames, it will only produce bounding boxes which have at least this confidence score. Value in 0 to 1 range, default is 0.5. max_bounding_box_count - (int64) No more than this number of bounding boxes will be returned per frame. Default is 100, the requested value may be limited by server. min_bounding_box_size - (float) Only bounding boxes with shortest edge at least that long as a relative value of video frame size will be returned. Value in 0 to 1 range. Default is 0.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/automl/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AutoML::V1beta1::PredictionService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AutoML::V1beta1::BatchPredictRequest.new

# Call the batch_predict method.
result = client.batch_predict request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the PredictionService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new PredictionService REST client object.

Yields
  • (config) — Configure the PredictionService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::AutoML::V1beta1::PredictionService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AutoML::V1beta1::PredictionService::Rest::Client.new do |config|
  config.timeout = 10.0
end

#operations_client

def operations_client() -> ::Google::Cloud::AutoML::V1beta1::PredictionService::Rest::Operations

Get the associated client for long-running operations.

Returns

#predict

def predict(request, options = nil) -> ::Google::Cloud::AutoML::V1beta1::PredictResponse
def predict(name: nil, payload: nil, params: nil) -> ::Google::Cloud::AutoML::V1beta1::PredictResponse

Perform an online prediction. The prediction result will be directly returned in the response. Available for following ML problems, and their expected request payloads:

  • Image Classification - Image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.
  • Image Object Detection - Image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.
  • Text Classification - TextSnippet, content up to 60,000 characters, UTF-8 encoded.
  • Text Extraction - TextSnippet, content up to 30,000 characters, UTF-8 NFC encoded.
  • Translation - TextSnippet, content up to 25,000 characters, UTF-8 encoded.
  • Tables - Row, with column values matching the columns of the model, up to 5MB. Not available for FORECASTING

[prediction_type][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type].

  • Text Sentiment - TextSnippet, content up 500 characters, UTF-8 encoded.
Overloads 
def predict(request, options = nil) -> ::Google::Cloud::AutoML::V1beta1::PredictResponse
Pass arguments to predict via a request object, either of type Google::Cloud::AutoML::V1beta1::PredictRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AutoML::V1beta1::PredictRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def predict(name: nil, payload: nil, params: nil) -> ::Google::Cloud::AutoML::V1beta1::PredictResponse
Pass arguments to predict via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the model requested to serve the prediction.
  • payload (::Google::Cloud::AutoML::V1beta1::ExamplePayload, ::Hash) — Required. Payload to perform a prediction on. The payload must match the problem type that the model was trained to solve.
  • params (::Hash{::String => ::String}) —

    Additional domain-specific parameters, any string must be up to 25000 characters long.

    • For Image Classification:

    score_threshold - (float) A value from 0.0 to 1.0. When the model makes predictions for an image, it will only produce results that have at least this confidence score. The default is 0.5.

    • For Image Object Detection: score_threshold - (float) When Model detects objects on the image, it will only produce bounding boxes which have at least this confidence score. Value in 0 to 1 range, default is 0.5. max_bounding_box_count - (int64) No more than this number of bounding boxes will be returned in the response. Default is 100, the requested value may be limited by server.
      • For Tables: feature_importance - (boolean) Whether feature importance should be populated in the returned TablesAnnotation. The default is false.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/automl/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AutoML::V1beta1::PredictionService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AutoML::V1beta1::PredictRequest.new

# Call the predict method.
result = client.predict request

# The returned object is of type Google::Cloud::AutoML::V1beta1::PredictResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)