stealth-luis 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c94f820865869cc8b51140b58cd0795086098a105a2a809dbaadf962b5545252
-  data.tar.gz: cca0d3584223c186d30c9795082c9a4e8eedf07d913c7cb318c9aaab040eaac2
+  metadata.gz: 26190207d9a05e1834bdc87a01e776086a2ebe42185721318da7dad8bb99d571
+  data.tar.gz: bf40713a23368020624fe4ece78672c5036cb6f024d97060c2c39a8e3b0af697
 SHA512:
-  metadata.gz: c0507f391523b949dc419891cfa2a91840329284e000dcbcf0039abf4415ba519d9af05b75fdffccc325bbf843a6882bb81a2ad003aec4d4e9f89530fc87b730
-  data.tar.gz: 8ef9b0dfbb967d143e8e6ba14c35d4305591aa610455eacc7103b53319a000df9819fb86b112da1764dff46ddb80173531d1d66f9aec140b85e2f10fe8cb7b0f
+  metadata.gz: 23605e8ac81023589db30ca9598d39086d2373b76785a97769a368aaf00cdca105706935e1001caf6705c2db792780ed4819bd70d99fbab93a87f0015f7f03c2
+  data.tar.gz: 82a1e7268c759dc2817b7d603f3de4dface711de5b37c41927f4a08c318f3381b739ea7429e80d5fb14f55909ddc857b9e7b6751e0603c41f443a60334955090

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# Changelog 1.2.1
+
+## Features
+
+* Updated gems
+
+# Changelog 1.2.0
+
+## Bugfixes
+
+* `datetimeReference` is not respected by LUIS when specified as a `GET`. Switched to `POST`
+* Renamed `tz_offset` option to `datetime_reference` to more closely match the LUIS API
+
+# Changelog 1.1.0
+
+## Features
+
+* Added intent threshold option; intents with lower scores than the threshold are not matched.
+
 # Changelog 1.0.0
 
 ## Bugfixes

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'stealth', git: 'https://github.com/hellostealth/stealth', branch: 'master'
+gem 'stealth', '>= 2.0.0.beta'
 
 gemspec

data/Gemfile.lock

@@ -1,44 +1,31 @@
-GIT
-  remote: https://github.com/hellostealth/stealth
-  revision: d6d3c626d2faa951203da652f733c4a18162e1f5
-  branch: master
-  specs:
-    stealth (2.0.0)
-      activesupport (~> 6.0)
-      multi_json (~> 1.12)
-      puma (>= 4.2, < 5.0)
-      sidekiq (~> 6.0)
-      sinatra (~> 2.0)
-      thor (~> 1.0)
-
 PATH
   remote: .
   specs:
-    stealth-luis (0.9.0)
+    stealth-luis (1.2.1)
       http (~> 4)
-      stealth (~> 2.0)
+      stealth (>= 2.0.0.beta)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.1)
+    activesupport (6.0.3.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    concurrent-ruby (1.1.6)
-    connection_pool (2.2.2)
-    diff-lcs (1.3)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
+    diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.12.2)
+    ffi (1.13.1)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    http (4.3.0)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
@@ -48,62 +35,68 @@ GEM
     http-form_data (2.3.0)
     http-parser (1.2.1)
       ffi-compiler (>= 1.0, < 2.0)
-    i18n (1.8.2)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.0)
-    multi_json (1.14.1)
+    minitest (5.14.2)
+    multi_json (1.15.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
-    nio4r (2.5.2)
-    public_suffix (4.0.3)
-    puma (4.3.3)
+    nio4r (2.5.4)
+    public_suffix (4.0.6)
+    puma (4.3.6)
       nio4r (~> 2.0)
-    rack (2.2.2)
-    rack-protection (2.0.8.1)
+    rack (2.2.3)
+    rack-protection (2.1.0)
       rack
     rake (13.0.1)
-    redis (4.1.3)
+    redis (4.2.2)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
     ruby2_keywords (0.0.2)
-    sidekiq (6.0.5)
+    sidekiq (6.1.2)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
-      rack-protection (>= 2.0.0)
-      redis (>= 4.1.0)
-    sinatra (2.0.8.1)
+      redis (>= 4.2.0)
+    sinatra (2.1.0)
       mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.8.1)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
       tilt (~> 2.0)
+    stealth (2.0.0.beta1)
+      activesupport (~> 6.0)
+      multi_json (~> 1.12)
+      puma (>= 4.2, < 5.0)
+      sidekiq (~> 6.0)
+      sinatra (~> 2.0)
+      thor (~> 1.0)
     thor (1.0.1)
     thread_safe (0.3.6)
     tilt (2.0.10)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
-    zeitwerk (2.3.0)
+    unf_ext (0.0.7.7)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   rspec (= 3.9.0)
-  stealth!
+  stealth (>= 2.0.0.beta)
   stealth-luis!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -16,6 +16,7 @@ default: &default
     app_id: 9434fbd8-420b-6d75-8a6f-b6c9a0ac5ec0
     subscription_key: 1b69a4b9db669805b4fcba5f1f2f87bb
     tz_offset: 0
+    intent_threshold: 0.2
 
 production:
   <<: *default
@@ -49,6 +50,10 @@ Otherwise, the intent named `yes` and the intent named `no` will attempt to be m
 
 For more info about how intents are matched, please see the [Stealth NLP documentation](https://github.com/hellostealth/stealth/wiki/NLP).
 
+### intent_threshold
+
+This is the real number that respresents the minimum threshold required for an intent to match. So if for example your `intent_threshold` is set to `0.2`, if the top intent scores `0.09`, it will not be returned as a match.
+
 ## Entities
 
 The entity types listed below are named using their corresponding Stealth type. The equivalent type used by Microsoft LUIS is also listed. For each code sample, the sample query is first provided followed by the array of entities extracted from the queries (for the given type).

data/lib/stealth/nlp/luis/client.rb

@@ -5,12 +5,12 @@ module Stealth
     module Luis
       class Client < Stealth::Nlp::Client
 
-        def initialize(subscription_key: nil, app_id: nil, endpoint: nil, tz_offset: 0)
+        def initialize(subscription_key: nil, app_id: nil, endpoint: nil, datetime_ref: nil)
           begin
             @subscription_key = subscription_key || Stealth.config.luis.subscription_key
             @app_id = app_id || Stealth.config.luis.app_id
             @endpoint = endpoint || Stealth.config.luis.endpoint
-            @tz_offset = tz_offset || Stealth.config.luis.tz_offset
+            @datetime_ref = datetime_ref || Stealth.config.luis.datetime_reference
             @slot = Stealth.env.development? ? 'staging' : 'production'
           rescue NoMethodError
             raise(
@@ -35,16 +35,21 @@ module Stealth
 
         def understand(query:)
           params = {
-            'datetimeReference'   => @tz_offset,
-            'subscription-key'    => @subscription_key,
-            'query'               => query
+            'subscription-key'    => @subscription_key
           }
 
+          body = MultiJson.dump({
+            'query'               => query,
+            'options'             => {
+              'datetimeReference' => @datetime_ref,
+            }
+          })
+
           Stealth::Logger.l(
             topic: :nlp,
             message: 'Performing NLP lookup via Microsoft LUIS'
           )
-          result = client.get(endpoint, params: params)
+          result = client.post(endpoint, params: params, body: body)
           Result.new(result: result)
         end
 

data/lib/stealth/nlp/luis/result.rb

@@ -71,7 +71,7 @@ module Stealth
         end
 
         def intent_score
-          parsed_result&.dig('prediction', 'intents', top_intent)
+          parsed_result&.dig('prediction', 'intents', top_intent, 'score')
         end
 
         def raw_entities
@@ -105,7 +105,24 @@ module Stealth
         private
 
         def top_intent
-          parsed_result&.dig('prediction', 'topIntent')
+          @top_intent ||= begin
+            matched_intent = parsed_result&.dig('prediction', 'topIntent')
+            _intent_score = parsed_result&.dig('prediction', 'intents', matched_intent, 'score')
+
+            if Stealth.config.luis.intent_threshold.is_a?(Numeric)
+              if _intent_score > Stealth.config.luis.intent_threshold
+                matched_intent
+              else
+                Stealth::Logger.l(
+                  topic: :nlp,
+                  message: "Ignoring intent match. Does not meet threshold (#{Stealth.config.luis.intent_threshold})"
+                )
+                'None' # can't be nil or this doesn't get memoized
+              end
+            else
+              matched_intent
+            end
+          end
         end
 
       end

data/stealth-luis.gemspec

@@ -1,17 +1,22 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
 Gem::Specification.new do |s|
   s.name        = 'stealth-luis'
-  s.version     = '1.0.0'
+  s.version     = '1.2.1'
   s.summary     = "Stealth LUIS"
   s.description = "Built-in NLP for Stealth bots via Microsoft's Language Understanding (LUIS)."
   s.authors     = ["Mauricio Gomes"]
   s.email       = 'mauricio@edge14.com'
-  s.files       = `git ls-files`.split("\n")
   s.homepage    = 'http://github.com/hellostealth/stealth-luis'
   s.license     = 'MIT'
 
-  s.add_dependency 'stealth', '~> 2.0'
+  s.add_dependency 'stealth', '>= 2.0.0.beta'
   s.add_dependency 'http', '~> 4'
 
   s.add_development_dependency "rspec", "= 3.9.0"
 
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stealth-luis
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Mauricio Gomes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stealth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0.beta
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +75,7 @@ homepage: http://github.com/hellostealth/stealth-luis
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,7 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Stealth LUIS
-test_files: []
+test_files:
+- spec/spec_helper.rb