Skip to content

technopreneurG/nlu_adapter_ruby

Repository files navigation

NluAdapter

An adapter to various NLU web services

Gem Version

Installation

Add this line to your application's Gemfile:

gem 'nlu_adapter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nlu_adapter

Usage

NLU Adapter support matrix

NLU Service Intent Intent Intent Intent Collection Intent Collection Intent Collection Intent identification
Create Get Update Create Get Update
Aws Lex (doc) Yes Yes Yes Yes Yes Yes Yes
Google Dialogflow (doc) Yes Yes Yes To-Do To-Do To-Do Yes
IBM Watson Assistant (doc) Yes Yes Yes To-Do To-Do To-Do Yes

Classification metrics

Supported intent classification metrics

  • Accuracy
  • Confusion Matrix
  • 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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/technopreneurG/nlu_adapter_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the NluAdapter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.