google-cloud-automl-v1 0.1.0 → 0.1.1

data/lib/google/cloud/automl/v1/prediction_service/client.rb

@@ -41,15 +41,15 @@ module Google
             ##
             # Configure the PredictionService Client class.
             #
-            # See {Google::Cloud::AutoML::V1::PredictionService::Client::Configuration}
+            # See {::Google::Cloud::AutoML::V1::PredictionService::Client::Configuration}
             # for a description of the configuration fields.
             #
             # ## Example
             #
             # To modify the configuration for all PredictionService clients:
             #
-            #     Google::Cloud::AutoML::V1::PredictionService::Client.configure do |config|
-            #       config.timeout = 10_000
+            #     ::Google::Cloud::AutoML::V1::PredictionService::Client.configure do |config|
+            #       config.timeout = 10.0
             #     end
             #
             # @yield [config] Configure the Client client.
@@ -85,7 +85,7 @@ module Google
             # 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}
+            # See {::Google::Cloud::AutoML::V1::PredictionService::Client::Configuration}
             # for a description of the configuration fields.
             #
             # @yield [config] Configure the Client client.
@@ -106,13 +106,13 @@ module Google
             # To create a new PredictionService client with the default
             # configuration:
             #
-            #     client = Google::Cloud::AutoML::V1::PredictionService::Client.new
+            #     client = ::Google::Cloud::AutoML::V1::PredictionService::Client.new
             #
             # To create a new PredictionService client with a custom
             # configuration:
             #
-            #     client = Google::Cloud::AutoML::V1::PredictionService::Client.new do |config|
-            #       config.timeout = 10_000
+            #     client = ::Google::Cloud::AutoML::V1::PredictionService::Client.new do |config|
+            #       config.timeout = 10.0
             #     end
             #
             # @yield [config] Configure the PredictionService client.
@@ -144,8 +144,8 @@ module Google
                 config.endpoint = @config.endpoint
               end
 
-              @prediction_service_stub = Gapic::ServiceStub.new(
-                Google::Cloud::AutoML::V1::PredictionService::Stub,
+              @prediction_service_stub = ::Gapic::ServiceStub.new(
+                ::Google::Cloud::AutoML::V1::PredictionService::Stub,
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
@@ -156,7 +156,7 @@ module Google
             ##
             # Get the associated client for long-running operations.
             #
-            # @return [Google::Cloud::AutoML::V1::PredictionService::Operations]
+            # @return [::Google::Cloud::AutoML::V1::PredictionService::Operations]
             #
             attr_reader :operations_client
 
@@ -167,51 +167,47 @@ module Google
             # returned in the response.
             # Available for following ML scenarios, and their expected request payloads:
             #
-            # <table>
-            # <tr>
-            # <td>AutoML Vision Classification</td>
-            # <td>An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.</td>
-            # </tr>
-            # <tr>
-            # <td>AutoML Vision Object Detection</td>
-            # <td>An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.</td>
-            # </tr>
-            # <tr>
-            # <td>AutoML Natural Language Classification</td>
-            # <td>A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in
-            # .PDF, .TIF or .TIFF format with size upto 2MB.</td>
-            # </tr>
-            # <tr>
-            # <td>AutoML Natural Language Entity Extraction</td>
-            # <td>A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document
-            #  in .PDF, .TIF or .TIFF format with size upto 20MB.</td>
-            # </tr>
-            # <tr>
-            # <td>AutoML Natural Language Sentiment Analysis</td>
-            # <td>A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in
-            # .PDF, .TIF or .TIFF format with size upto 2MB.</td>
-            # </tr>
-            # <tr>
-            # <td>AutoML Translation</td>
-            # <td>A TextSnippet up to 25,000 characters, UTF-8 encoded.</td>
-            # </tr>
-            # <tr>
-            # <td>AutoML Tables</td>
-            # <td>A row with column values matching
+            # 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`.
-            # </td>
-            # </tr>
-            # </table>
             #
             # @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.
+            #   {::Google::Cloud::AutoML::V1::PredictRequest} or an equivalent Hash.
             #
-            #   @param request [Google::Cloud::AutoML::V1::PredictRequest, 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]
+            #   @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)
@@ -219,23 +215,23 @@ module Google
             #   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]
+            #   @param name [::String]
             #     Required. Name of the model requested to serve the prediction.
-            #   @param payload [Google::Cloud::AutoML::V1::ExamplePayload, Hash]
+            #   @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}]
+            #   @param params [::Hash{::String => ::String}]
             #     Additional domain-specific parameters, any string must be up to 25000
             #     characters long.
             #
-            #     <h4>AutoML Vision Classification</h4>
+            #     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.
             #
-            #     <h4>AutoML Vision Object Detection</h4>
+            #     AutoML Vision Object Detection
             #
             #     `score_threshold`
             #     : (float) When Model detects objects on the image,
@@ -247,7 +243,7 @@ module Google
             #       boxes returned. The default is 100. The
             #       number of returned bounding boxes might be limited by the server.
             #
-            #     <h4>AutoML Tables</h4>
+            #     AutoML Tables
             #
             #     `feature_importance`
             #     : (boolean) Whether
@@ -258,26 +254,26 @@ module Google
             #       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]
+            # @yieldparam response [::Google::Cloud::AutoML::V1::PredictResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
             #
-            # @return [Google::Cloud::AutoML::V1::PredictResponse]
+            # @return [::Google::Cloud::AutoML::V1::PredictResponse]
             #
-            # @raise [Google::Cloud::Error] if the RPC is aborted.
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
             def predict request, options = nil
-              raise ArgumentError, "request must be provided" if request.nil?
+              raise ::ArgumentError, "request must be provided" if request.nil?
 
-              request = Gapic::Protobuf.coerce request, to: Google::Cloud::AutoML::V1::PredictRequest
+              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
+              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 \
+              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
@@ -298,17 +294,17 @@ module Google
                 yield response, operation if block_given?
                 return response
               end
-            rescue GRPC::BadStatus => e
-              raise Google::Cloud::Error.from_error(e)
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
             end
 
             ##
-            # Perform a batch prediction. Unlike the online {Google::Cloud::AutoML::V1::PredictionService::Client#predict Predict}, batch
+            # 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.
+            # 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
@@ -321,12 +317,12 @@ module Google
             #
             # @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.
+            #   {::Google::Cloud::AutoML::V1::BatchPredictRequest} or an equivalent Hash.
             #
-            #   @param request [Google::Cloud::AutoML::V1::BatchPredictRequest, 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]
+            #   @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)
@@ -334,18 +330,18 @@ module Google
             #   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]
+            #   @param name [::String]
             #     Required. Name of the model requested to serve the batch prediction.
-            #   @param input_config [Google::Cloud::AutoML::V1::BatchPredictInputConfig, Hash]
+            #   @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]
+            #   @param output_config [::Google::Cloud::AutoML::V1::BatchPredictOutputConfig, ::Hash]
             #     Required. The Configuration specifying where output predictions should
             #     be written.
-            #   @param params [Hash{String => String}]
+            #   @param params [::Hash{::String => ::String}]
             #     Additional domain-specific parameters for the predictions, any string must
             #     be up to 25000 characters long.
             #
-            #     <h4>AutoML Natural Language Classification</h4>
+            #     AutoML Natural Language Classification
             #
             #     `score_threshold`
             #     : (float) A value from 0.0 to 1.0. When the model
@@ -353,14 +349,14 @@ module Google
             #       that have at least this confidence score. The default is 0.5.
             #
             #
-            #     <h4>AutoML Vision Classification</h4>
+            #     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.
             #
-            #     <h4>AutoML Vision Object Detection</h4>
+            #     AutoML Vision Object Detection
             #
             #     `score_threshold`
             #     : (float) When Model detects objects on the image,
@@ -371,7 +367,7 @@ module Google
             #     : (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.
-            #     <h4>AutoML Video Intelligence Classification</h4>
+            #     AutoML Video Intelligence Classification
             #
             #     `score_threshold`
             #     : (float) A value from 0.0 to 1.0. When the model
@@ -409,7 +405,7 @@ module Google
             #       type, the quality of it depends on training data, but there are no
             #       metrics provided to describe that quality.
             #
-            #     <h4>AutoML Video Intelligence Object Tracking</h4>
+            #     AutoML Video Intelligence Object Tracking
             #
             #     `score_threshold`
             #     : (float) When Model detects objects on video frames,
@@ -427,26 +423,26 @@ module Google
             #       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]
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
             #
-            # @return [Gapic::Operation]
+            # @return [::Gapic::Operation]
             #
-            # @raise [Google::Cloud::Error] if the RPC is aborted.
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
             def batch_predict request, options = nil
-              raise ArgumentError, "request must be provided" if request.nil?
+              raise ::ArgumentError, "request must be provided" if request.nil?
 
-              request = Gapic::Protobuf.coerce request, to: Google::Cloud::AutoML::V1::BatchPredictRequest
+              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
+              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 \
+              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
@@ -464,12 +460,12 @@ module Google
                                      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
+                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)
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
             end
 
             ##
@@ -479,7 +475,7 @@ module Google
             # providing control over timeouts, retry behavior, logging, transport
             # parameters, and other low-level controls. Certain parameters can also be
             # applied individually to specific RPCs. See
-            # {Google::Cloud::AutoML::V1::PredictionService::Client::Configuration::Rpcs}
+            # {::Google::Cloud::AutoML::V1::PredictionService::Client::Configuration::Rpcs}
             # for a list of RPCs that can be configured independently.
             #
             # Configuration can be applied globally to all clients, or to a single client
@@ -490,22 +486,22 @@ module Google
             # To modify the global config, setting the timeout for predict
             # to 20 seconds, and all remaining timeouts to 10 seconds:
             #
-            #     Google::Cloud::AutoML::V1::PredictionService::Client.configure do |config|
-            #       config.timeout = 10_000
-            #       config.rpcs.predict.timeout = 20_000
+            #     ::Google::Cloud::AutoML::V1::PredictionService::Client.configure do |config|
+            #       config.timeout = 10.0
+            #       config.rpcs.predict.timeout = 20.0
             #     end
             #
             # To apply the above configuration only to a new client:
             #
-            #     client = Google::Cloud::AutoML::V1::PredictionService::Client.new do |config|
-            #       config.timeout = 10_000
-            #       config.rpcs.predict.timeout = 20_000
+            #     client = ::Google::Cloud::AutoML::V1::PredictionService::Client.new do |config|
+            #       config.timeout = 10.0
+            #       config.rpcs.predict.timeout = 20.0
             #     end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.
             #   Defaults to `"automl.googleapis.com"`.
-            #   @return [String]
+            #   @return [::String]
             # @!attribute [rw] credentials
             #   Credentials to send with calls. You may provide any of the following types:
             #    *  (`String`) The path to a service account key file in JSON format
@@ -517,29 +513,29 @@ module Google
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
-            #   @return [Object]
+            #   @return [::Object]
             # @!attribute [rw] scope
             #   The OAuth scopes
-            #   @return [Array<String>]
+            #   @return [::Array<::String>]
             # @!attribute [rw] lib_name
             #   The library name as recorded in instrumentation and logging
-            #   @return [String]
+            #   @return [::String]
             # @!attribute [rw] lib_version
             #   The library version as recorded in instrumentation and logging
-            #   @return [String]
+            #   @return [::String]
             # @!attribute [rw] channel_args
             #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
             #   `GRPC::Core::Channel` object is provided as the credential.
-            #   @return [Hash]
+            #   @return [::Hash]
             # @!attribute [rw] interceptors
             #   An array of interceptors that are run before calls are executed.
-            #   @return [Array<GRPC::ClientInterceptor>]
+            #   @return [::Array<::GRPC::ClientInterceptor>]
             # @!attribute [rw] timeout
-            #   The call timeout in milliseconds.
-            #   @return [Numeric]
+            #   The call timeout in seconds.
+            #   @return [::Numeric]
             # @!attribute [rw] metadata
             #   Additional gRPC headers to be sent with the call.
-            #   @return [Hash{Symbol=>String}]
+            #   @return [::Hash{::Symbol=>::String}]
             # @!attribute [rw] retry_policy
             #   The retry policy. The value is a hash with the following keys:
             #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
@@ -547,10 +543,10 @@ module Google
             #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
             #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
             #       trigger a retry.
-            #   @return [Hash]
+            #   @return [::Hash]
             #
             class Configuration
-              extend Gapic::Config
+              extend ::Gapic::Config
 
               config_attr :endpoint,     "automl.googleapis.com", String
               config_attr :credentials,  nil do |value|
@@ -558,14 +554,14 @@ module Google
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                 allowed.any? { |klass| klass === value }
               end
-              config_attr :scope,        nil, String, Array, nil
-              config_attr :lib_name,     nil, String, nil
-              config_attr :lib_version,  nil, String, nil
-              config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, Hash, nil)
-              config_attr :interceptors, nil, Array, nil
-              config_attr :timeout,      nil, Numeric, nil
-              config_attr :metadata,     nil, Hash, nil
-              config_attr :retry_policy, nil, Hash, Proc, nil
+              config_attr :scope,        nil, ::String, ::Array, nil
+              config_attr :lib_name,     nil, ::String, nil
+              config_attr :lib_version,  nil, ::String, nil
+              config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+              config_attr :interceptors, nil, ::Array, nil
+              config_attr :timeout,      nil, ::Numeric, nil
+              config_attr :metadata,     nil, ::Hash, nil
+              config_attr :retry_policy, nil, ::Hash, Proc, nil
 
               # @private
               def initialize parent_config = nil
@@ -606,21 +602,21 @@ module Google
               class Rpcs
                 ##
                 # RPC-specific configuration for `predict`
-                # @return [Gapic::Config::Method]
+                # @return [::Gapic::Config::Method]
                 #
                 attr_reader :predict
                 ##
                 # RPC-specific configuration for `batch_predict`
-                # @return [Gapic::Config::Method]
+                # @return [::Gapic::Config::Method]
                 #
                 attr_reader :batch_predict
 
                 # @private
                 def initialize parent_rpcs = nil
                   predict_config = parent_rpcs&.predict if parent_rpcs&.respond_to? :predict
-                  @predict = Gapic::Config::Method.new predict_config
+                  @predict = ::Gapic::Config::Method.new predict_config
                   batch_predict_config = parent_rpcs&.batch_predict if parent_rpcs&.respond_to? :batch_predict
-                  @batch_predict = Gapic::Config::Method.new batch_predict_config
+                  @batch_predict = ::Gapic::Config::Method.new batch_predict_config
 
                   yield self if block_given?
                 end

data/lib/google/cloud/automl/v1/prediction_service/credentials.rb

@@ -24,7 +24,7 @@ module Google
       module V1
         module PredictionService
           # Credentials for the PredictionService API.
-          class Credentials < Google::Auth::Credentials
+          class Credentials < ::Google::Auth::Credentials
             self.scope = [
               "https://www.googleapis.com/auth/cloud-platform"
             ]