Class: NexosisApi::Client

Inherits:
Object
  • Object
show all
Includes:
HTTParty, Contest, Datasets, Imports, Models, Sessions, Views, Vocabulary
Defined in:
lib/nexosis_api/client.rb,
lib/nexosis_api/client/views.rb,
lib/nexosis_api/client/models.rb,
lib/nexosis_api/client/contest.rb,
lib/nexosis_api/client/imports.rb,
lib/nexosis_api/client/datasets.rb,
lib/nexosis_api/client/sessions.rb,
lib/nexosis_api/client/vocabulary.rb

Overview

class to operate on vocabulary endpoint in Nexosis API

Defined Under Namespace

Modules: Contest, Datasets, Imports, Models, Sessions, Views, Vocabulary

Instance Method Summary collapse

Methods included from Vocabulary

#get_vocabulary, #list_vocabularies

Methods included from Contest

#get_contest_champion, #get_contestant_results, #get_contestants, #get_selection_metrics, #get_session_contest

Methods included from Models

#get_model, #list_models, #predict, #remove_model, #remove_models

Methods included from Views

#create_view, #create_view_by_def, #get_view, #list_views, #remove_view

Methods included from Imports

#import_from_azure, #import_from_s3, #import_from_url, #list_imports, #retrieve_import

Methods included from Datasets

#create_dataset_csv, #create_dataset_json, #get_column_stats, #get_dataset, #get_dataset_csv, #list_datasets, #remove_dataset

Methods included from Sessions

#create_anomalies_model, #create_classification_model, #create_forecast_session, #create_impact_session, #create_model, #get_anomaly_scores, #get_class_scores, #get_confusion_matrix, #get_distance_metrics, #get_feature_importance, #get_session, #get_session_result_data, #get_session_results, #get_timeseries_outliers, #list_sessions, #remove_session, #remove_sessions

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.

Raises:

  • (ArgumentError) 


63
64
65
66
67
68
69
70
 
# File 'lib/nexosis_api/client.rb', line 63

def initialize(options = {})
  raise ArgumentError, 'api_key was not defined' unless options[:api_key].nil? == false
  @api_key = options[:api_key]
  self.class.base_uri options[:base_uri] unless options[:base_uri].nil?
  @headers = { 'api-key' => @api_key, 'Content-Type' => 'application/json',
               'User-Agent' => 'Nexosis-Ruby-API-Client/2.1' }
  @options = { headers: @headers, format: :json }
end

Instance Method Details

#api_key(value) ⇒ String

Provide access to read or modify the api key

Returns:

  • (String)

Since:

  • 2.0.0



84
85
86
87
88
 
# File 'lib/nexosis_api/client.rb', line 84

def api_key(value)
  @api_key = value unless value.nil?
  @headers['api-key'] = @api_key
  @api_key
end

#get_account_quotas ⇒ Hash

Gets the quota stats for the account

Returns:

  • (Hash) —

    a hash of quota values and current values



75
76
77
78
79
 
# File 'lib/nexosis_api/client.rb', line 75

def ()
  session_url = '/sessions?page=0&pageSize=1'
  response = self.class.get(session_url, @options)
  response.headers.select { |k, _v| k.to_s.start_with? 'nexosis-account' }
end