stealth-clu 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e55190619ceeaca0ad9383dfae313f0ac0d0c5c1b0a79b25ee73cae587ed312a
+  data.tar.gz: 592c902a0613c7a16b4ee2ab65191a7239313ea3a663cfbfde6d18aa1a053c20
+SHA512:
+  metadata.gz: a45dc6113768ca60904a4cbc2572eb6a05fa644fb305ce4bd5be307d2549ef773306289176967dc438a6d83bbdb4adae79f8638e34a402fbf3b55c6dae7cd157
+  data.tar.gz: b5ec3ad781eaf03224efe08321cfb39a7575b68a877f9d3d2d7b4ae828d4d26ce86bb39b68cb828f0dc01b7b5664a5e70d46729658f2702eeb88f8509473593a

data/.github/workflows/ci.yml

@@ -0,0 +1,13 @@
+name: CI
+on:
+  push:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+          bundler-cache: true

data/.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release Gem
+on:
+  # Triggers the workflow on push with a tag prefixed with v*
+  push:
+    tags:
+      - 'v*'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+          bundler-cache: true
+      - name: Publish gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem

data/.gitignore

@@ -0,0 +1,12 @@
+# please add general patterns to your global ignore list
+# see https://github.com/github/gitignore#readme
+.DS_STORE
+*.swp
+*.rbc
+*.sass-cache
+/pkg
+/doc/api
+/coverage
+.yardoc
+doc/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'stealth', '>= 2.0.0.beta'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    stealth-clu (1.0.0)
+      http (~> 4)
+      stealth (>= 2.0.0.beta)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7.10)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    diff-lcs (1.6.2)
+    domain_name (0.6.20240107)
+    ffi (1.17.2)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86_64-darwin)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
+      rake
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.8)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    minitest (5.25.5)
+    multi_json (1.15.0)
+    mustermann (2.0.2)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.7.4)
+    public_suffix (6.0.2)
+    puma (5.6.9)
+      nio4r (~> 2.0)
+    rack (2.2.14)
+    rack-protection (2.2.4)
+      rack
+    rake (13.2.1)
+    redis (4.8.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.3)
+    ruby2_keywords (0.0.5)
+    sidekiq (6.5.12)
+      connection_pool (>= 2.2.5, < 3)
+      rack (~> 2.0)
+      redis (>= 4.5.0, < 5)
+    sinatra (2.2.4)
+      mustermann (~> 2.0)
+      rack (~> 2.2)
+      rack-protection (= 2.2.4)
+      tilt (~> 2.0)
+    stealth (2.0.0.beta7)
+      activesupport (~> 6.0)
+      multi_json (~> 1.12)
+      puma (>= 4.2, < 6.0)
+      sidekiq (< 7)
+      sinatra (~> 2.0)
+      thor (~> 1.0)
+    thor (1.3.2)
+    tilt (2.6.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  arm64-darwin
+  ruby
+  x86_64-darwin
+
+DEPENDENCIES
+  rspec (~> 3)
+  stealth (>= 2.0.0.beta)
+  stealth-clu!
+
+BUNDLED WITH
+   2.6.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Stealth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# stealth-clu
+Built-in NLP for Stealth bots via Microsoft's Conversational Language Understanding (CLU)

data/VERSION

@@ -0,0 +1 @@
+1.0.0

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Stealth
+  module Nlp
+    module Clu
+      class Client < Stealth::Nlp::Client
+
+        def initialize(subscription_key: nil, project_name: nil, deployment_name: nil, endpoint: nil, datetime_ref: nil)
+          begin
+            @subscription_key = subscription_key || Stealth.config.clu.subscription_key
+            @project_name = project_name || Stealth.config.clu.project_name
+            @deployment_name = deployment_name || Stealth.config.clu.deployment_name
+            @endpoint = endpoint || Stealth.config.clu.endpoint
+            @datetime_ref = datetime_ref || Stealth.config.clu.datetime_reference
+          rescue NoMethodError
+            raise(
+              Stealth::Errors::ConfigurationError,
+              'A `clu` configuration key must be specified directly or in `services.yml`'
+            )
+          end
+        end
+
+        def endpoint
+          "https://#{@endpoint}/language/:analyze-conversations?api-version=2023-04-01"
+        end
+
+        def client
+          @client ||= begin
+            headers = {
+              'Content-Type' => 'application/json',
+              'Ocp-Apim-Subscription-Key' => @subscription_key
+            }
+            HTTP.timeout(connect: 15, read: 60).headers(headers)
+          end
+        end
+
+        def understand(query:)
+          body = MultiJson.dump({
+            'kind' => 'Conversation',
+            'analysisInput' => {
+              'conversationItem' => {
+                'participantId' => '1',
+                'id' => '1',
+                'modality' => 'text',
+                'language' => 'en',
+                'text' => query
+              }
+            },
+            'parameters' => {
+              'projectName' => @project_name,
+              'deploymentName' => @deployment_name,
+              'stringIndexType' => 'TextElement_V8',
+              'verbose' => true
+            }
+          })
+
+          Stealth::Logger.l(
+            topic: :nlp,
+            message: 'Performing NLP lookup via Microsoft CLU'
+          )
+
+          result = client.post(endpoint, body: body)
+          Result.new(result: result)
+        end
+
+      end
+    end
+  end
+end
+
+ENTITY_TYPES = %i(number currency email percentage phone age
+                        url ordinal geo dimension temp datetime)

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module Stealth
+  module Nlp
+    module Clu
+      class Result < Stealth::Nlp::Result
+
+        # https://learn.microsoft.com/en-us/azure/ai-services/language-service/conversational-language-understanding/prebuilt-component-reference
+        ENTITY_MAP = {
+          'money' => :currency, 'number' => :number, 'email' => :email,
+          'percentage' => :percentage, 'geographyV2' => :geo, 'age' => :age,
+          'phonenumber' => :phone, 'ordinalV2' => :ordinal, 'url' => :url,
+          'dimension' => :dimension, 'temperature' => :temp, 'keyPhrase' => :key_phrase,
+          'personName' => :name, 'datetimeV2' => :datetime
+        }
+
+        def initialize(result:)
+          @result = result
+          if result.status.success?
+            Stealth::Logger.l(
+              topic: :nlp,
+              message: 'NLP lookup successful'
+            )
+            parsed_result
+          else
+            Stealth::Logger.l(
+              topic: :nlp,
+              message: "NLP lookup FAILED: (#{result.status.code}) #{result.body.to_s}"
+            )
+          end
+
+        end
+
+        # https://learn.microsoft.com/en-gb/azure/ai-services/language-service/conversational-language-understanding/how-to/call-api?tabs=REST-APIs#test-the-model
+        # Sample JSON result:
+        # {
+        #   "kind": "ConversationResult",
+        #   "result": {
+        #     "query": "Text1",
+        #     "prediction": {
+        #       "topIntent": "intent1",
+        #       "projectKind": "Conversation",
+        #       "intents": [
+        #         {
+        #           "category": "intent1",
+        #           "confidenceScore": 1
+        #         },
+        #         {
+        #           "category": "intent2",
+        #           "confidenceScore": 0
+        #         },
+        #         {
+        #           "category": "intent3",
+        #           "confidenceScore": 0
+        #         }
+        #       ],
+        #       "entities": [
+        #         {
+        #           "category": "entity1",
+        #           "text": "text1",
+        #           "offset": 29,
+        #           "length": 12,
+        #           "confidenceScore": 1
+        #         }
+        #       ]
+        #     }
+        #   }
+        # }
+
+        def parsed_result
+          @parsed_result ||= MultiJson.load(result.body.to_s)
+        end
+
+        def intent
+          top_intent&.to_sym
+        end
+
+        def intent_score
+          parsed_result&.
+              dig('result', 'prediction', 'intents')&.
+              find { |intent| intent['category'] == top_intent }&.
+              dig('confidenceScore')
+        end
+
+        def raw_entities
+          parsed_result&.dig('result', 'prediction', 'entities')
+        end
+
+        # https://learn.microsoft.com/en-us/azure/ai-services/language-service/named-entity-recognition/concepts/entity-resolutions
+        def entities
+          return {} if raw_entities.blank?
+          _entities = {}
+
+          raw_entities.each do |entity|
+            category = entity["category"]
+            mapped_category = ENTITY_MAP[category] || category
+
+            _entities[mapped_category.to_sym] ||= []
+            _entities[mapped_category.to_sym] << entity
+          end
+
+          _entities
+        end
+
+        # def sentiment_score
+        #   parsed_result&.dig('prediction', 'sentiment', 'score')
+        # end
+
+        # def sentiment
+        #   parsed_result&.dig('prediction', 'sentiment', 'label')&.to_sym
+        # end
+
+        private
+
+        def top_intent
+          @top_intent ||= begin
+            matched_intent = parsed_result&.dig('result', 'prediction', 'topIntent')
+            _intent_score = parsed_result&.
+              dig('result', 'prediction', 'intents')&.
+              find { |intent| intent['category'] == matched_intent }&.
+              dig('confidenceScore')
+
+            if Stealth.config.clu.intent_threshold.is_a?(Numeric)
+              if _intent_score > Stealth.config.clu.intent_threshold
+                matched_intent
+              else
+                Stealth::Logger.l(
+                  topic: :nlp,
+                  message: "Ignoring intent match. Does not meet threshold (#{Stealth.config.clu.intent_threshold})"
+                )
+                'None' # can't be nil or this doesn't get memoized
+              end
+            else
+              matched_intent
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/stealth/nlp/clu.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'stealth/nlp/clu/result'
+require 'stealth/nlp/clu/client'

data/lib/stealth-clu.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require 'stealth/nlp/result'
+require 'stealth/nlp/client'
+require 'stealth/nlp/clu'

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'stealth-clu'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/stealth-clu.gemspec

@@ -0,0 +1,24 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+version = File.read(File.join(File.dirname(__FILE__), 'VERSION')).strip
+
+Gem::Specification.new do |s|
+  s.name        = 'stealth-clu'
+  s.version     = version
+  s.summary     = "Stealth CLU"
+  s.description = "Built-in NLP for Stealth bots via Microsoft's Conversational Language Understanding (CLU)"
+  s.authors     = ["Emilie Morissette"]
+  s.email       = 'emorissettegregoire@gmail.com'
+  s.homepage    = 'http://github.com/hellostealth/stealth-clu'
+  s.license     = 'MIT'
+
+  s.add_dependency 'stealth', '>= 2.0.0.beta'
+  s.add_dependency 'http', '~> 4'
+
+  s.add_development_dependency "rspec", "~> 3"
+
+  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

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: stealth-clu
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Emilie Morissette
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-09-17 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.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Built-in NLP for Stealth bots via Microsoft's Conversational Language
+  Understanding (CLU)
+email: emorissettegregoire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- VERSION
+- lib/stealth-clu.rb
+- lib/stealth/nlp/clu.rb
+- lib/stealth/nlp/clu/client.rb
+- lib/stealth/nlp/clu/result.rb
+- spec/spec_helper.rb
+- stealth-clu.gemspec
+homepage: http://github.com/hellostealth/stealth-clu
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Stealth CLU
+test_files: []