chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
google-api-ruby-client/generated/google/apis/prediction_v1_2/service.rb

288 lines
15 KiB
Ruby
Raw Normal View History

Autogenerated update (2017-08-26) Add: - adexchangebuyer_v1_2 - adexchangebuyer_v1_3 - adexchangeseller_v1 - adexchangeseller_v1_1 - analytics_v2_4 - androidpublisher_v1 - androidpublisher_v1_1 - appengine_v1alpha - appengine_v1beta - appengine_v1beta4 - appengine_v1beta5 - blogger_v2 - cloudfunctions_v1beta2 - cloudresourcemanager_v2beta1 - clouduseraccounts_alpha - clouduseraccounts_vm_beta - compute_alpha - container_v1beta1 - content_v2sandbox - dataproc_v1beta2 - datastore_v1beta3 - deploymentmanager_alpha - deploymentmanager_v2beta - fusiontables_v1 - genomics_v1alpha2 - language_v1beta2 - ml_v1beta1 - oauth2_v1 - pagespeedonline_v1 - prediction_v1_2 - prediction_v1_3 - prediction_v1_4 - prediction_v1_5 - pubsub_v1beta1a - pubsub_v1beta2 - replicapool_v1beta1 - resourceviews_v1beta1 - runtimeconfig_v1beta1 - sqladmin_v1beta3 - storage_v1beta1 - storage_v1beta2 - taskqueue_v1beta1 - toolresults_v1beta3firstparty - youtube_analytics_v1beta1 Update: - admin_directory_v1 - cloudresourcemanager_v1beta1 - cloudtrace_v1 - dfareporting_v2_7 - dns_v2beta1 - drive_v2 - language_v1beta1 - logging_v2beta1 - speech_v1beta1
2017-08-26 01:31:01 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module PredictionV1_2
# 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_2'
#
# Prediction = Google::Apis::PredictionV1_2 # Alias the module
# service = Prediction::PredictionService.new
#
# @see https://developers.google.com/prediction/docs/developer-guide
class PredictionService < Google::Apis::Core::BaseService
# @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.
attr_accessor :key
# @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.
attr_accessor :quota_user
# @return [String]
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'prediction/v1.2/')
@batch_path = 'batch'
end
# Submit data and request a prediction
# @param [String] data
# mybucket%2Fmydata resource in Google Storage
# @param [Google::Apis::PredictionV1_2::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_2::Output] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PredictionV1_2::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
def predict(data, input_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'training/{data}/predict', options)
command.request_representation = Google::Apis::PredictionV1_2::Input::Representation
command.request_object = input_object
command.response_representation = Google::Apis::PredictionV1_2::Output::Representation
command.response_class = Google::Apis::PredictionV1_2::Output
command.params['data'] = data unless data.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] hosted_model_name
# The name of a hosted model
# @param [Google::Apis::PredictionV1_2::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_2::Output] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PredictionV1_2::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
def predict_hostedmodel(hosted_model_name, input_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'hostedmodels/{hostedModelName}/predict', options)
command.request_representation = Google::Apis::PredictionV1_2::Input::Representation
command.request_object = input_object
command.response_representation = Google::Apis::PredictionV1_2::Output::Representation
command.response_class = Google::Apis::PredictionV1_2::Output
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
# Delete a trained model
# @param [String] data
# mybucket/mydata resource in Google Storage
# @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
def delete_training(data, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'training/{data}', options)
command.params['data'] = data unless data.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] data
# mybucket/mydata resource in Google Storage
# @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_2::Training] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PredictionV1_2::Training]
#
# @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
def get_training(data, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'training/{data}', options)
command.response_representation = Google::Apis::PredictionV1_2::Training::Representation
command.response_class = Google::Apis::PredictionV1_2::Training
command.params['data'] = data unless data.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
# Begin training your model
# @param [Google::Apis::PredictionV1_2::Training] training_object
# @param [String] data
# mybucket/mydata resource in Google Storage
# @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_2::Training] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PredictionV1_2::Training]
#
# @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
def insert_training(training_object = nil, data: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'training', options)
command.request_representation = Google::Apis::PredictionV1_2::Training::Representation
command.request_object = training_object
command.response_representation = Google::Apis::PredictionV1_2::Training::Representation
command.response_class = Google::Apis::PredictionV1_2::Training
command.query['data'] = data unless data.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] data
# mybucket/mydata resource in Google Storage
# @param [Google::Apis::PredictionV1_2::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_2::Training] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PredictionV1_2::Training]
#
# @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
def update_training(data, update_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:put, 'training/{data}', options)
command.request_representation = Google::Apis::PredictionV1_2::Update::Representation
command.request_object = update_object
command.response_representation = Google::Apis::PredictionV1_2::Training::Representation
command.response_class = Google::Apis::PredictionV1_2::Training
command.params['data'] = data unless data.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
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
end
end
end
end