nlu_adapter 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25db10d98a5439cbbc18327adba57ed9422211b2088644d950d9172cb8ed210f
-  data.tar.gz: 4ccf19d8a3633de04e0764fa74c374d185e3182dece8750cb3d9a7931a07167a
+  metadata.gz: 40656e57b36f5684b58789c2fc8756f6c311c5e5cd54e3151a61687df70ba2c8
+  data.tar.gz: 494f66bdcb5bc7083e048d2da54ec7e64b7bd1a5d1edd26b6a6ae287f1102b2b
 SHA512:
-  metadata.gz: a6184e011cda087ec1e98cb5a81da9f3e01a982e05fdb7d75946bc2a3e083573f61a1992139533f2d73f6b4a42c4b1de73f36fcf30c68189e1b45347e7a3eee6
-  data.tar.gz: 136be99c729217c0e7af0e24c7fc5401dad0f311dc60045b58b8490b48ee160d4a871d72fc156f61cb2e5ed823ca23c97e3b507e07ce3b4fea82d3effb9b4a0e
+  metadata.gz: 5eaa23df59165d67b674e7a96cd53e65353548fa3ef34cfb9f56e818468ab383fbab98cddab7f8cc1233fae1caec4f7afa9280c2784e795b205f3275e48faa5d
+  data.tar.gz: 0aada1752399c7a77b921e9ec9e8bc1cfb6a400cb571f124431393bee12a6e435b1d2321f4903ac91f30c5f3b8e783129a8b8fdfa85c91c92fae2ff77c8b1648

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.1.6
+---
+* enhancements to test report
+  * added support for :json, :csv, :yaml and :hash formats
+
 0.1.5 (22/Feb/2019)
 ---
 * Added IBM Watson Assistant

data/README.md

@@ -21,17 +21,17 @@ Or install it yourself as:
 
 ## Usage
 
-Check [documentation](docs) for usage.
+* Check [documentation](docs) for usage.
+* Check [nlu toolset](https://github.com/technopreneurG/nlu_tools_ruby) on how this lib is utilised to create cli tools.
 
 ## NLU Adapter support matrix
 
-C: Create, R: Get, U: Update, D: Delete
-
-NLU Service | Intent | Intet Collection | Intent identification
------------ | ------ | ---------------- | ---------------------
-[Aws Lex](https://aws.amazon.com/lex/) ([doc](docs/lex.md)) | C,R,U | C,R,U | Yes
-[Google Dialogflow](https://dialogflow.com/) ([doc](docs/dialogflow.md)) | C,R,U | To-Do | Yes
-[IBM Watson Assistant](https://cloud.ibm.com/catalog/services/watson-assistant) ([doc](docs/watson_assistant.md)) | C,R,U | To-Do | Yes
+| NLU Service | Intent | Intent | Intent | Intent Collection | Intent Collection | Intent Collection | Intent identification
+|--- | --- | --- | --- | --- | --- | --- | ---
+| | **Create** | **Get** | **Update**  | **Create** | **Get** | **Update** |
+[Aws Lex](https://aws.amazon.com/lex/) ([doc](docs/lex.md)) | Yes | Yes | Yes | Yes | Yes | Yes | Yes
+[Google Dialogflow](https://dialogflow.com/) ([doc](docs/dialogflow.md)) | Yes | Yes | Yes | To-Do | To-Do | To-Do | Yes
+[IBM Watson Assistant](https://cloud.ibm.com/catalog/services/watson-assistant) ([doc](docs/watson_assistant.md)) | Yes | Yes | Yes | To-Do | To-Do | To-Do | Yes
 
 ## Classification metrics
 ### Supported intent classification metrics
@@ -40,6 +40,13 @@ NLU Service | Intent | Intet Collection | Intent identification
 * Precision (per Class)
 * Recall (per Class)
 
+### Supported intent classification report formats
+* JSON
+* CSV
+* YAML
+* Ruby-Hash
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/nlu_adapter/dialogflow.rb

@@ -22,10 +22,15 @@ module NluAdapter
 				sessions_client = Google::Cloud::Dialogflow::Sessions.new(version: :v2)
 				formatted_session = Google::Cloud::Dialogflow::V2::SessionsClient.session_path(@project_id, @session_id)
 				language_code = 'en'
+				intent_name = :NO_INTENT_FOUND
+
 				query_input = Google::Cloud::Dialogflow::V2::QueryInput.new({text: {language_code: language_code, text: text}})
 				response = sessions_client.detect_intent(formatted_session, query_input)
 
-				return { intent_name: response.query_result.intent.display_name }
+				unless response.nil? || response.query_result.nil? || response.query_result.intent.nil? || response.query_result.intent.display_name.empty?
+					intent_name = response.query_result.intent.display_name
+				end
+				return { intent_name: intent_name }
 			end
 
 			# Get an instance of Intent, if it exists else nil

data/lib/nlu_adapter/lex.rb

@@ -23,7 +23,7 @@ module NluAdapter
 			# @return [Json] return the identified intent name
 			#
 			def parse(text)
-				intent_name = nil
+				intent_name = :NO_INTENT_FOUND
 				begin
 					resp = @lex_client.post_text({
 						bot_name: @bot_name, # required
@@ -38,7 +38,9 @@ module NluAdapter
 						input_text: text, # required
 					})
 
-					intent_name = resp.intent_name #=> String
+					unless resp.intent_name.nil? || resp.intent_name.empty?
+						intent_name = resp.intent_name  #=> String
+					end
 				rescue Aws::Lex::Errors::ServiceError => e
 					puts "Error: #{e.inspect}"
 				end

data/lib/nlu_adapter/parse_helper.rb

@@ -1,5 +1,6 @@
 require 'csv'
 require 'json'
+require 'yaml'
 
 #helper functions to parse text and match intent
 module NluAdapter
@@ -28,19 +29,63 @@ module NluAdapter
 		#
 		#  Example input/output
 		#  test_data
-		#   {"BookHotel":["please book a hotel"],"intent1":["book me a hotel, please","book a hotel"]}
+		#    {
+		#      "Intent1"=>["APR for personal credit cards", "interest rates for personal credit cards"], 
+		#      "Intent2"=>["Am I still part of the rewards program?", "Am I still in the loyalty program?"]
+		#    }
 		#  test_results
-		#   json:
-		#   [{"text":"book me a hotel, please","expected":"intent1","got":"BookHotel"},{"text":"book a hotel","expected":"intent1","got":"BookHotel"},{"text":"please book a hotel","expected":"BookHotel","got":"BookHotel"}]
-		#   csv:
-		#   "book me a hotel, please",intent1,BookHotel
-		#   book a hotel,intent1,BookHotel
-		#   please book a hotel,BookHotel,BookHotel
-		#   hash:
-		#   [{:text=>"book me a hotel, please", :expected=>"intent1", :got=>"BookHotel"}, {:text=>"book a hotel", :expected=>"intent1", :got=>"BookHotel"}, {:text=>"please book a hotel", :expected=>"BookHotel", :got=>"BookHotel"}]
+		#    json:
+		#      [
+		#         {
+		#            "text" : "APR for personal credit cards",
+		#            "expected" : "Intent1",
+		#            "got" : "Intent1"
+		#         },
+		#         {
+		#            "text" : "interest rates for personal credit cards",
+		#            "expected" : "Intent1",
+		#            "got" : "Intent1"
+		#         },
+		#         {
+		#            "text" : "Am I still part of the rewards program?",
+		#            "expected" : "Intent2",
+		#            "got" : "Intent3"
+		#         },
+		#         {
+		#            "text" : "Am I still in the loyalty program?",
+		#            "expected" : "Intent2",
+		#            "got" : "Intent3"
+		#         }
+		#      ]
+		#    csv:
+		#      APR for personal credit cards,Intent1,Intent1
+		#      interest rates for personal credit cards,Intent1,Intent1
+		#      Am I still part of the rewards program?,Intent2,Intent3
+		#      Am I still in the loyalty program?,Intent2,Intent3
+		#    hash:
+		#      [
+		#        {:text=>"APR for personal credit cards", :expected=>"Intent1", :got=>"Intent1"},
+		#        {:text=>"interest rates for personal credit cards", :expected=>"Intent1", :got=>"Intent1"},
+		#        {:text=>"Am I still part of the rewards program?", :expected=>"Intent2", :got=>"Intent3"},
+		#        {:text=>"Am I still in the loyalty program?", :expected=>"Intent2", :got=>"Intent3"}
+		#      ]
+		#    yaml:
+		#      ---
+		#      - :text: APR for personal credit cards
+		#        :expected: Intent1
+		#        :got: Intent1
+		#      - :text: interest rates for personal credit cards
+		#        :expected: Intent1
+		#        :got: Intent1
+		#      - :text: Am I still part of the rewards program?
+		#        :expected: Intent2
+		#        :got: Intent3
+		#      - :text: Am I still in the loyalty program?
+		#        :expected: Intent2
+		#        :got: Intent3
 		#
 		# @param test_data [Json]: Test data in specified format
-		# @param output_format [Symbol] supported formats :csv, :json or :hash
+		# @param output_format [Symbol] supported formats :csv, :json, :yaml or :hash
 		# @return [test_results]: output the test results in expected format
 		#
 		def parse_test(test_data, output_format = :hash)
@@ -59,6 +104,8 @@ module NluAdapter
 				return to_csv(test_results)
 			when :hash
 				return test_results
+			when :yaml
+				return test_results.to_yaml
 			else
 				puts 'Warning: valid format not specified'
 				return test_results
@@ -69,11 +116,80 @@ module NluAdapter
 
 		# run the parse tests with test_data and generate test report
 		#
+		#  Example input/output
+		#  test_data
+		#    {
+		#      "Intent1"=>["APR for personal credit cards", "interest rates for personal credit cards"], 
+		#      "Intent2"=>["Am I still part of the rewards program?", "Am I still in the loyalty program?"]
+		#    }
+		#  test_report
+		#    json:
+		#      {
+		#        "accuracy":50.0,
+		#        "confusion_matrix":"Matrix[[2, 0, 0], [0, 0, 2], [0, 0, 0]]",
+		#        "classification_report": {
+		#            "Intent1":{"precision":1.0,"recall":1.0,"class_total":2},
+		#            "Intent2":{"precision":0.0,"recall":0.0,"class_total":2},
+		#            "Intent3":{"precision":0.0,"recall":0.0,"class_total":0}
+		#        }
+		#      }
+		#    csv:
+		#      Accuracy,50.0
+		#      CONFUSION MATRIX:
+		#      "",Intent1,Intent2,Intent3
+		#      Intent1,2,0,0
+		#      Intent2,0,0,2
+		#      Intent3,0,0,0
+		#      CLASSIFICATION REPORT:
+		#      Class,Precision,Recall,Class total
+		#      Intent1,1.0,1.0,2
+		#      Intent2,0.0,0.0,2
+		#      Intent3,0.0,0.0,0
+		#    hash:
+		#      {
+		#        :accuracy=>50.0,
+		#        :confusion_matrix=>Matrix[[2, 0, 0], [0, 0, 2], [0, 0, 0]],
+		#        :classification_report=>{
+		#          :"Intent1"=>{:precision=>1.0, :recall=>1.0, :class_total=>2},
+		#          :"Intent2"=>{:precision=>0.0, :recall=>0.0, :class_total=>2},
+		#          :"Intent3"=>{:precision=>0.0, :recall=>0.0, :class_total=>0}
+		#        }
+		#      }
+		#    yaml:
+		#      ---
+		#      :accuracy: 50.0
+		#      :confusion_matrix: !ruby/object:Matrix
+		#        rows:
+		#        - - 2
+		#          - 0
+		#          - 0
+		#        - - 0
+		#          - 0
+		#          - 2
+		#        - - 0
+		#          - 0
+		#          - 0
+		#        column_count: 3
+		#      :classification_report:
+		#        :Intent1:
+		#          :precision: 1.0
+		#          :recall: 1.0
+		#          :class_total: 2
+		#        :Intent2:
+		#          :precision: 0.0
+		#          :recall: 0.0
+		#          :class_total: 2
+		#        :Intent3:
+		#          :precision: 0.0
+		#          :recall: 0.0
+		#          :class_total: 0
+		#
 		# @param test_data [Json]: Test data in specified format
+		# @param output_format [Symbol] supported formats :csv, :json, :yaml or :hash
 		# @return [test_report]: generate a test report
 		# @todo F1-Score
 		#
-		def parse_test_report(test_data)
+		def parse_test_report(test_data, output_format = :hash)
 			test_results = parse_test(test_data)
 			expected = []
 			got = []
@@ -82,9 +198,25 @@ module NluAdapter
 				got << result[:got]
 			end
 
-			m = Metrics.new(expected, got)
+			test_report = {accuracy: 0, confusion_matrix: [], classification_report: {}}
+			if !got.reject { |e| e.to_s.empty? }.empty?
+				m = Metrics.new(expected, got)
+				test_report = {accuracy: m.accuracy, confusion_matrix: m.confusion_matrix, classification_report: m.classification_report}
+			end
 
-			return {accuracy: m.accuracy, confusion_matrix: m.confusion_matrix, classification_report: m.classification_report}
+			case output_format
+			when :json
+				return test_report.to_json
+			when :csv
+				return report_to_csv(test_report)
+			when :hash
+				return test_report
+			when :yaml
+				return test_report.to_yaml
+			else
+				puts 'Warning: valid format not specified'
+				return test_report
+			end
 		end
 
 		private
@@ -96,5 +228,27 @@ module NluAdapter
 			end
 			csv_string
 		end
+
+		def report_to_csv(test_report)
+
+			csv_string = CSV.generate do |csv|
+				csv << ["Accuracy", test_report[:accuracy]]
+				csv << ["CONFUSION MATRIX:"]
+				class_row = [""]
+				test_report[:classification_report].each do |c, r|
+					class_row << c
+				end
+				csv << class_row
+				test_report[:confusion_matrix].to_a.each_with_index do |row, i|
+					csv << [class_row[i+1]] + row
+				end
+				csv << ["CLASSIFICATION REPORT:"]
+				csv << ["Class", "Precision", "Recall", "Class total"]
+				test_report[:classification_report].each do |c, r|
+					csv << [c, r[:precision], r[:recall], r[:class_total]]
+				end
+			end
+			csv_string
+		end
 	end
 end

data/lib/nlu_adapter/version.rb

@@ -1,3 +1,3 @@
 module NluAdapter
-	VERSION = "0.1.5"
+	VERSION = "0.1.6"
 end

data/lib/nlu_adapter/watson_assistant.rb

@@ -32,7 +32,7 @@ module NluAdapter
 			# @return [Json] return the identified intent name
 			#
 			def parse(text)
-				intent_name = nil
+				intent_name = :NO_INTENT_FOUND
 				begin
 					response = @assistant.message(
 						workspace_id: @workspace_id,
@@ -41,7 +41,9 @@ module NluAdapter
 						}
 					)
 
-					intent_name = response.result["intents"][0]["intent"]
+					unless response.nil? || response.result.nil? || response.result["intents"].nil? || response.result["intents"][0].nil?
+						intent_name = response.result["intents"][0]["intent"]
+					end
 				rescue WatsonApiException => ex
 					puts "Error: #{ex.inspect}"
 				end

data/nlu_adapter.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
     spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata["source_code_uri"] = "https://github.com/technopreneurG/nlu_adapter_ruby"
     spec.metadata["changelog_uri"] = "https://github.com/technopreneurG/nlu_adapter_ruby/blob/master/CHANGELOG.md"
+    spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/nlu_adapter"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nlu_adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Girish Nair
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,7 @@ metadata:
   homepage_uri: https://rubygems.org/gems/nlu_adapter
   source_code_uri: https://github.com/technopreneurG/nlu_adapter_ruby
   changelog_uri: https://github.com/technopreneurG/nlu_adapter_ruby/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/nlu_adapter
 post_install_message: 
 rdoc_options: []
 require_paths: