class Google::Apis::PredictionV1_6::PredictionService
Prediction API
Lets you access a cloud hosted machine learning service that makes it easy to
build smart apps
@example
require 'google/apis/prediction_v1_6' Prediction = Google::Apis::PredictionV1_6 # Alias the module service = Prediction::PredictionService.new
Attributes
@return [String]
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
@return [String]
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@return [String]
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Public Class Methods
# File generated/google/apis/prediction_v1_6/service.rb, line 52 def initialize super('https://www.googleapis.com/', 'prediction/v1.6/projects/') end
Public Instance Methods
Get analysis of the model and the data the model was trained on. @param [String] project
The project associated with the model.
@param [String] id
The unique name for the predictive model.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PredictionV1_6::Analyze] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PredictionV1_6::Analyze]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/prediction_v1_6/service.rb, line 123 def analyze_trained_model(project, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/trainedmodels/{id}/analyze', options) command.response_representation = Google::Apis::PredictionV1_6::Analyze::Representation command.response_class = Google::Apis::PredictionV1_6::Analyze command.params['project'] = project unless project.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Delete a trained model. @param [String] project
The project associated with the model.
@param [String] id
The unique name for the predictive model.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/prediction_v1_6/service.rb, line 161 def delete_trained_model(project, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/trainedmodels/{id}', options) command.params['project'] = project unless project.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Check training status of your model. @param [String] project
The project associated with the model.
@param [String] id
The unique name for the predictive model.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PredictionV1_6::Insert2] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PredictionV1_6::Insert2]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/prediction_v1_6/service.rb, line 197 def get_trained_model(project, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/trainedmodels/{id}', options) command.response_representation = Google::Apis::PredictionV1_6::Insert2::Representation command.response_class = Google::Apis::PredictionV1_6::Insert2 command.params['project'] = project unless project.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Train a Prediction API model. @param [String] project
The project associated with the model.
@param [Google::Apis::PredictionV1_6::Insert] insert_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PredictionV1_6::Insert2] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PredictionV1_6::Insert2]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/prediction_v1_6/service.rb, line 234 def insert_trained_model(project, insert_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/trainedmodels', options) command.request_representation = Google::Apis::PredictionV1_6::Insert::Representation command.request_object = insert_object command.response_representation = Google::Apis::PredictionV1_6::Insert2::Representation command.response_class = Google::Apis::PredictionV1_6::Insert2 command.params['project'] = project unless project.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
List available models. @param [String] project
The project associated with the model.
@param [Fixnum] max_results
Maximum number of results to return.
@param [String] page_token
Pagination token.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PredictionV1_6::List] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PredictionV1_6::List]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/prediction_v1_6/service.rb, line 275 def list_trained_models(project, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/trainedmodels/list', options) command.response_representation = Google::Apis::PredictionV1_6::List::Representation command.response_class = Google::Apis::PredictionV1_6::List command.params['project'] = project unless project.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Submit input and request an output against a hosted model. @param [String] project
The project associated with the model.
@param [String] hosted_model_name
The name of a hosted model.
@param [Google::Apis::PredictionV1_6::Input] input_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PredictionV1_6::Output] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PredictionV1_6::Output]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/prediction_v1_6/service.rb, line 83 def predict_hosted_model(project, hosted_model_name, input_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/hostedmodels/{hostedModelName}/predict', options) command.request_representation = Google::Apis::PredictionV1_6::Input::Representation command.request_object = input_object command.response_representation = Google::Apis::PredictionV1_6::Output::Representation command.response_class = Google::Apis::PredictionV1_6::Output command.params['project'] = project unless project.nil? command.params['hostedModelName'] = hosted_model_name unless hosted_model_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Submit model id and request a prediction. @param [String] project
The project associated with the model.
@param [String] id
The unique name for the predictive model.
@param [Google::Apis::PredictionV1_6::Input] input_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PredictionV1_6::Output] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PredictionV1_6::Output]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/prediction_v1_6/service.rb, line 315 def predict_trained_model(project, id, input_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/trainedmodels/{id}/predict', options) command.request_representation = Google::Apis::PredictionV1_6::Input::Representation command.request_object = input_object command.response_representation = Google::Apis::PredictionV1_6::Output::Representation command.response_class = Google::Apis::PredictionV1_6::Output command.params['project'] = project unless project.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Add new data to a trained model. @param [String] project
The project associated with the model.
@param [String] id
The unique name for the predictive model.
@param [Google::Apis::PredictionV1_6::Update] update_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::PredictionV1_6::Insert2] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::PredictionV1_6::Insert2]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/prediction_v1_6/service.rb, line 356 def update_trained_model(project, id, update_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/trainedmodels/{id}', options) command.request_representation = Google::Apis::PredictionV1_6::Update::Representation command.request_object = update_object command.response_representation = Google::Apis::PredictionV1_6::Insert2::Representation command.response_class = Google::Apis::PredictionV1_6::Insert2 command.params['project'] = project unless project.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File generated/google/apis/prediction_v1_6/service.rb, line 372 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? end