class Google::Cloud::AutoML::V1::PredictionService::Client

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.

Attributes

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::AutoML::V1::PredictionService::Operations]

prediction_service_stub[R]

@private

Public Class Methods

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

Configure the PredictionService Client class.

See {::Google::Cloud::AutoML::V1::PredictionService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all PredictionService clients
::Google::Cloud::AutoML::V1::PredictionService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/automl/v1/prediction_service/client.rb, line 59
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "AutoML", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.predict.timeout = 60.0

    default_config.rpcs.batch_predict.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new PredictionService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::AutoML::V1::PredictionService::Client.new

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

@yield [config] Configure the PredictionService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/automl/v1/prediction_service/client.rb, line 116
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/automl/v1/prediction_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.endpoint = @config.endpoint
  end

  @prediction_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::AutoML::V1::PredictionService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

batch_predict(request, options = nil) { |response, operation| ... } click to toggle source

Perform a batch prediction. Unlike the online {::Google::Cloud::AutoML::V1::PredictionService::Client#predict 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, {::Google::Cloud::AutoML::V1::BatchPredictResult BatchPredictResult} is returned in the {::Google::Longrunning::Operation#response response} field. Available for following ML scenarios:

  • AutoML Vision Classification

  • AutoML Vision Object Detection

  • AutoML Video Intelligence Classification

  • AutoML Video Intelligence Object Tracking * AutoML Natural Language Classification

  • AutoML Natural Language Entity Extraction

  • AutoML Natural Language Sentiment Analysis

  • AutoML Tables

@overload batch_predict(request, options = nil)

Pass arguments to `batch_predict` via a request object, either of type
{::Google::Cloud::AutoML::V1::BatchPredictRequest} or an equivalent Hash.

@param request [::Google::Cloud::AutoML::V1::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload batch_predict(name: nil, input_config: nil, output_config: nil, params: nil)

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).

@param name [::String]
  Required. Name of the model requested to serve the batch prediction.
@param input_config [::Google::Cloud::AutoML::V1::BatchPredictInputConfig, ::Hash]
  Required. The input configuration for batch prediction.
@param output_config [::Google::Cloud::AutoML::V1::BatchPredictOutputConfig, ::Hash]
  Required. The Configuration specifying where output predictions should
  be written.
@param params [::Hash{::String => ::String}]
  Additional domain-specific parameters for the predictions, any string must
  be up to 25000 characters long.

  AutoML Natural Language 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.

  AutoML Vision 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.

  AutoML Vision 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) The maximum number of bounding
    boxes returned per image. The default is 100, the
    number of bounding boxes returned might be limited by the server.
  AutoML Video Intelligence 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.
    The default is false.

    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.

  `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. The default is false.

    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.

  AutoML Video Intelligence 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) The maximum number of bounding
    boxes returned per image. The default is 100, the
    number of bounding boxes returned might be limited by the server.

  `min_bounding_box_size`
  : (float) Only bounding boxes with shortest edge
    at least that long as a relative value of video frame size are
    returned. Value in 0 to 1 range. Default is 0.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/automl/v1/prediction_service/client.rb, line 436
def batch_predict request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1::BatchPredictRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_predict.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AutoML::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_predict.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_predict.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @prediction_service_stub.call_rpc :batch_predict, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
configure() { |config| ... } click to toggle source

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 {::Google::Cloud::AutoML::V1::PredictionService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/automl/v1/prediction_service/client.rb, line 95
def configure
  yield @config if block_given?
  @config
end
predict(request, options = nil) { |response, operation| ... } click to toggle source

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

AutoML Vision Classification

  • An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.

AutoML Vision Object Detection

  • An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.

AutoML Natural Language Classification

  • A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in

.PDF, .TIF or .TIFF format with size upto 2MB.

AutoML Natural Language Entity Extraction

  • A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document

in .PDF, .TIF or .TIFF format with size upto 20MB.

AutoML Natural Language Sentiment Analysis

  • A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in

.PDF, .TIF or .TIFF format with size upto 2MB.

AutoML Translation

  • A TextSnippet up to 25,000 characters, UTF-8 encoded.

AutoML Tables

  • A row with column values matching the columns of the model, up to 5MB. Not available for FORECASTING `prediction_type`.

@overload predict(request, options = nil)

Pass arguments to `predict` via a request object, either of type
{::Google::Cloud::AutoML::V1::PredictRequest} or an equivalent Hash.

@param request [::Google::Cloud::AutoML::V1::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload predict(name: nil, payload: nil, params: nil)

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).

@param name [::String]
  Required. Name of the model requested to serve the prediction.
@param payload [::Google::Cloud::AutoML::V1::ExamplePayload, ::Hash]
  Required. Payload to perform a prediction on. The payload must match the
  problem type that the model was trained to solve.
@param params [::Hash{::String => ::String}]
  Additional domain-specific parameters, any string must be up to 25000
  characters long.

  AutoML Vision 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.

  AutoML Vision 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) The maximum number of bounding
    boxes returned. The default is 100. The
    number of returned bounding boxes might be limited by the server.

  AutoML Tables

  `feature_importance`
  : (boolean) Whether

  [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
    is populated in the returned list of
    [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
    objects. The default is false.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::AutoML::V1::PredictResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::AutoML::V1::PredictResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/automl/v1/prediction_service/client.rb, line 265
def predict request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AutoML::V1::PredictRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.predict.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::AutoML::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.predict.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.predict.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @prediction_service_stub.call_rpc :predict, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end