Class: Google::Apis::PredictionV1_6::PredictionService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/prediction_v1_6/service.rb

Overview

Prediction API

Lets you access a cloud hosted machine learning service that makes it easy to build smart apps

Examples:

require 'google/apis/prediction_v1_6'

Prediction = Google::Apis::PredictionV1_6 # Alias the module
service = Prediction::PredictionService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initialize ⇒ PredictionService

Returns a new instance of PredictionService.



52
53
54
 
# File 'generated/google/apis/prediction_v1_6/service.rb', line 52

def initialize
  super('https://www.googleapis.com/', 'prediction/v1.6/projects/')
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (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.



39
40
41
 
# File 'generated/google/apis/prediction_v1_6/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (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.



45
46
47
 
# File 'generated/google/apis/prediction_v1_6/service.rb', line 45

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



50
51
52
 
# File 'generated/google/apis/prediction_v1_6/service.rb', line 50

def user_ip
  @user_ip
end

Instance Method Details

#analyze_trained_model(project, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PredictionV1_6::Analyze

Get analysis of the model and the data the model was trained on.

Parameters:

  • project (String) —

    The project associated with the model.

  • id (String) —

    The unique name for the predictive model.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



123
124
125
126
127
128
129
130
131
132
133
 
# 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_trained_model(project, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a trained model.

Parameters:

  • project (String) —

    The project associated with the model.

  • id (String) —

    The unique name for the predictive model.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:



161
162
163
164
165
166
167
168
169
 
# 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

#get_trained_model(project, id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PredictionV1_6::Insert2

Check training status of your model.

Parameters:

  • project (String) —

    The project associated with the model.

  • id (String) —

    The unique name for the predictive model.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



197
198
199
200
201
202
203
204
205
206
207
 
# 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

#insert_trained_model(project, insert_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PredictionV1_6::Insert2

Train a Prediction API model.

Parameters:

  • project (String) —

    The project associated with the model.

  • insert_object (Google::Apis::PredictionV1_6::Insert) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



234
235
236
237
238
239
240
241
242
243
244
245
 
# 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_trained_models(project, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PredictionV1_6::List

List available models.

Parameters:

  • project (String) —

    The project associated with the model.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return.

  • page_token (String) (defaults to: nil) —

    Pagination token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



275
276
277
278
279
280
281
282
283
284
285
286
 
# 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

#predict_hosted_model(project, hosted_model_name, input_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PredictionV1_6::Output

Submit input and request an output against a hosted model.

Parameters:

  • project (String) —

    The project associated with the model.

  • hosted_model_name (String) —

    The name of a hosted model.

  • input_object (Google::Apis::PredictionV1_6::Input) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# 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

#predict_trained_model(project, id, input_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PredictionV1_6::Output

Submit model id and request a prediction.

Parameters:

  • project (String) —

    The project associated with the model.

  • id (String) —

    The unique name for the predictive model.

  • input_object (Google::Apis::PredictionV1_6::Input) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# 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

#update_trained_model(project, id, update_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PredictionV1_6::Insert2

Add new data to a trained model.

Parameters:

  • project (String) —

    The project associated with the model.

  • id (String) —

    The unique name for the predictive model.

  • update_object (Google::Apis::PredictionV1_6::Update) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# 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