nexosis_api 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c12a9dee350193af3df27068feb8161999a7d085
-  data.tar.gz: c2f3cd6d4b24c211a4eab0c5bd2ed07dd4e6b132
+  metadata.gz: c463f70058910101a5ec3b3ed201cc91ed27791c
+  data.tar.gz: '09331c0b0cd6c388851e1782942487038e69f50a'
 SHA512:
-  metadata.gz: 59e8f973c4aa67adb891ef177deeb8571ed99413a8efb6fc826e46058d286e9a308e1d87c014294ce9a4ae2e8b756402f0b592dbb1b31ba0cebfc9686360a17f
-  data.tar.gz: b3952c5b3d130305511310e4b77f028ada6832e90ecf1d113f8c842ece1ee2a82754553863d3766998c8c61da6fca998b4afda20de84b11042fd65ecff07ea74
+  metadata.gz: aa44a973d907bf7b9a55b4accb1b20669bcd0c8085ee9b92585240926d6d12517f6f14ff25d483097ac7215cc10153bafc319003301bfe23a211910d77f55f23
+  data.tar.gz: 0fe95f24b21264037f0e384af3fd9d8f1757b0e2235443c7041066cd167f1f49a2206a979d086ca4852d51e7a68c5dc2c203cf451239114e5a3b45fc2ef709ae

data/lib/nexosis_api/client/models.rb

@@ -61,8 +61,8 @@ module NexosisApi
       # @note For a classification model you may include the extra parameter 'includeClassScores' to
       #    get scores back for each class, not just the chosen class.
       def predict(model_id, feature_data, extra_parameters = {})
-        raise ArgumentError, 'Running predictions requires that model_id be specified and it is currently empty.' if model_id.empty?
-        raise ArgumentError, 'Running predictions requires that feature_data be specified and it is currently empty.' if feature_data.empty?
+        raise ArgumentError, 'Running predictions requires that model_id be specified and it is currently empty.' if model_id.nil? || model_id.empty?
+        raise ArgumentError, 'Running predictions requires that feature_data be specified and it is currently empty.' if feature_data.nil? || feature_data.empty?
         predict_url = "/models/#{model_id}/predict"
         feature_data = [feature_data] unless feature_data.kind_of?(Array)
         response = self.class.post(predict_url, headers: @headers, body: { 'data': feature_data, 'extraParameters': extra_parameters }.to_json)
@@ -81,7 +81,7 @@ module NexosisApi
       # @raise [NexosisApi::HttpException]
       # @raise [ArgumentError]
       def remove_model(model_id)
-        raise ArgumentError, 'Deleting a model requires that model_id be specified and it is currently empty.' if model_id.empty?
+        raise ArgumentError, 'Deleting a model requires that model_id be specified and it is currently empty.' if model_id.nil? || model_id.empty?
         delete_url = "/models/#{model_id}"
         response = self.class.delete(delete_url, @options)
         unless (response.success?)

data/lib/nexosis_api/client/vocabulary.rb

@@ -0,0 +1,60 @@
+module NexosisApi
+  # class to operate on vocabulary endpoint in Nexosis API
+  class Client
+    # Vocabluary-based API operations
+    # @see http://docs.nexosis.com/
+    # @since 2.2.0
+    module Vocabulary
+      # Gets summary information about the Vocabulary built from the Text columns in a session
+      # @param datasource_name [String] optionally limit to those
+      # vocabularies created for this data source name.
+      # @param created_from_session [String] optionally limit to those
+      # vocabularies created for the given session.
+      # @param page [Integer] the page number for paged results. Defaults to 0.
+      # @param page_size [Integer] the size of each page of paged results. Defaults to 50.
+      # @return [NexosisApi::PagedArray of NexosisApi::VocabularySummary] - all vocabularies available within the query parameters
+      # @raise [NexosisApi::HttpException]
+      def list_vocabularies(datasource_name = nil, created_from_session=nil, page = 0, page_size = 50)
+        vocab_url = '/vocabulary'
+        query = {
+          page: page,
+          pageSize: page_size
+        }
+        query.store('created_from_session', datasource_name) unless created_from_session.nil?
+        query.store('dataSourceName', datasource_name) unless datasource_name.nil?
+        response = self.class.get(vocab_url, headers: @headers, query: query)
+        raise HttpException.new("There was a problem listing vocabularies: #{response.code}.",
+                                "listing vocabularies with data source name #{datasource_name}",
+                                response) unless response.success?
+        NexosisApi::PagedArray.new(response.parsed_response,
+                                   response.parsed_response['items']
+                                   .map { |item| NexosisApi::VocabularySummary.new(item) })
+      end
+
+      # Gets a list of Vocabulary Words from a vocabulary
+      # @param vocabulary_id [String] required unique identifier for vocabulary to get
+      # @param type [String] whether to return 'word' types (default), 'stopWord' for only stop words, or nil for both.
+      # @param page [Integer] the page number for paged results. Defaults to 0.
+      # @param page_size [Integer] the size of each page of paged results. Defaults to 50.
+      # @return [NexosisApi::PagedArray of NexosisApi::VocabularyWord]
+      # @note words will be sorted in rank order
+      # @raise [NexosisApi::HttpException]
+      def get_vocabulary(vocabulary_id, type = 'word', page = 0, page_size = 50)
+        raise ArgumentError, 'vocabulary_id was not provided and is not optional' if vocabulary_id.nil?
+        vocab_url = "/vocabulary/#{vocabulary_id}"
+        query = {
+          page: page,
+          pageSize: page_size
+        }
+        query.store('type', type) unless type.nil?
+        response = self.class.get(vocab_url, headers: @headers, query: query)
+        raise HttpException.new("There was a problem getting a vocabulary: #{response.code}.",
+                                "getting vocabulary #{vocabulary_id}",
+                                response) unless response.success?
+        NexosisApi::PagedArray.new(response.parsed_response,
+                                   response.parsed_response['items']
+                                   .map { |item| NexosisApi::VocabularyWord.new(item) })
+      end
+    end
+  end
+end

data/lib/nexosis_api/client.rb

@@ -30,11 +30,14 @@ require 'nexosis_api/session'
 require 'nexosis_api/time_interval'
 require 'nexosis_api/view_definition'
 require 'nexosis_api/view_data'
+require 'nexosis_api/vocabulary_summary'
+require 'nexosis_api/vocabulary_word'
 require 'nexosis_api/client/contest'
 require 'nexosis_api/client/sessions'
 require 'nexosis_api/client/datasets'
 require 'nexosis_api/client/imports'
 require 'nexosis_api/client/views'
+require 'nexosis_api/client/vocabulary'
 require 'nexosis_api/client/models'
 
 module NexosisApi
@@ -48,6 +51,7 @@ module NexosisApi
     include Client::Views
     include Client::Models
     include Client::Contest
+    include Client::Vocabulary
 
     def initialize(options = {})
       raise ArgumentError, 'api_key was not defined' unless options[:api_key].nil? == false

data/lib/nexosis_api/dataset_data.rb

@@ -7,6 +7,8 @@ module NexosisApi
           @data = NexosisApi::PagedArray.new(data_hash, v)
         elsif (k == 'links')
           @links = v.reject(&:nil?).map { |l| NexosisApi::Link.new(l) }
+        elsif (k == 'isTimeSeries')
+          @is_timeseries = v
         end
       end
     end
@@ -18,5 +20,10 @@ module NexosisApi
     # The hash of data values from the dataset
     # @return [NexosisApi::PagedArray of Hash] where each hash contains the dataset data
     attr_accessor :data
+
+    # Whether or not this dataset was loaded with a date-based key with a timestamp role
+    # @return [Boolean]
+    # @since 2.1.1
+    attr_reader :is_timeseries
   end
 end

data/lib/nexosis_api/vocabulary_summary.rb

@@ -0,0 +1,44 @@
+module NexosisApi
+  # parsed results of a request for vocabulary
+  # @since 2.2.0
+  class VocabularySummary
+    def initialize(vocab_hash)
+      var_map = { 'id' => :@vocabulary_id,
+                  'dataSourceName' => :@datasource_name,
+                  'columnName' => :@column_name,
+                  'dataSourceType' => :@datasource_type,
+                  'createdOnDate' => :@created_on,
+                  'createdBySessionId' => :@created_by_session }
+      vocab_hash.each { |k, v| instance_variable_set(var_map[k.to_s], v) unless var_map[k.to_s].nil? }
+      @links = vocab_hash['links'].reject(&:nil?).map { |l| NexosisApi::Link.new(l) }
+    end
+
+    # unique identifier for this vocabulary
+    # @return [String]
+    attr_reader :vocabulary_id
+
+    # datasource which contained the text column the vocabulary was built from
+    # @return [String]
+    attr_reader :datasource_name
+
+    # text-based column name from the datasource
+    # @return [String]
+    attr_reader :column_name
+
+    # determines if data source was dataSet, View, or other
+    # @return [String]
+    attr_reader :datasource_type
+
+    # The date on which the vocabulary was created
+    # @return [DateTime]
+    attr_reader :created_on
+
+    # The unique id of the session for which this vocabulary was built.
+    # @reutn [String]
+    attr_reader :created_by_session
+
+    # hypermedia related to this vocabulary
+    # @return [Arrays]
+    attr_reader :links
+  end
+end

data/lib/nexosis_api/vocabulary_word.rb

@@ -0,0 +1,22 @@
+module NexosisApi
+  # parse results of a single word entry in a vocabulary
+  # @since 2.2.0
+  class VocabularyWord
+    def initialize(word_hash)
+      word_hash.each { |k, v| instance_variable_set("@#{k}", v) }
+    end
+
+    # The actual word or word pair
+    # @return [String]
+    attr_reader :text
+
+    # Either word or stopWord
+    # @return [String]
+    attr_reader :type
+
+    # For words the rank or relative importance of the word in predictions. Nil for stop words.
+    # @return [Integer]
+    attr_reader :rank
+
+  end
+end

data/nexosisapi.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
   spec.summary = "Ruby client for working with the Nexosis API"
-  spec.version = '2.1.0'
+  spec.version = '2.2.0'
   spec.metadata["yard.run"] = "yri"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexosis_api
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Nexosis,Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,7 @@ files:
 - lib/nexosis_api/client/models.rb
 - lib/nexosis_api/client/sessions.rb
 - lib/nexosis_api/client/views.rb
+- lib/nexosis_api/client/vocabulary.rb
 - lib/nexosis_api/column.rb
 - lib/nexosis_api/column_options.rb
 - lib/nexosis_api/column_role.rb
@@ -85,6 +86,8 @@ files:
 - lib/nexosis_api/time_interval.rb
 - lib/nexosis_api/view_data.rb
 - lib/nexosis_api/view_definition.rb
+- lib/nexosis_api/vocabulary_summary.rb
+- lib/nexosis_api/vocabulary_word.rb
 - nexosisapi.gemspec
 homepage: https://github.com/nexosis/nexosisclient-rb
 licenses: