Gem Gem Build Status Maintainability

API wrapper for QnA Maker

QnA API docs


Add this line to your application's Gemfile:

gem 'qna_maker'

And then execute:

$ bundle

Or install it yourself as:

$ gem install qna_maker


require 'qna_maker'

client = QnAMaker::Client.new('kb_id' , 'subscription_key')
#=> #<QnAMaker::Client @knowledgebase_id="kb_id", @subscription_key="subscription_key", ...>

answers = client.generate_answer('hi')
#=> [#<QnAMaker::Answer @answer="hello", @questions=["hi"], @score=100.0>]

#=> "hello"

Development status

Gem is under active development! It isn't finished yet!

Todo list

  • [x] Methods
    • [x] POST - Create Knowledge Base
    • [x] DELETE - Delete Knowledge Base
    • [x] GET - Download Alterations
    • [x] GET - Download Knowledge Base
    • [x] POST - Generate answer
    • [x] PUT - Publish Knowledge Base
    • [x] PATCH - Train Knowledge Base
    • [x] PATCH - Update Alterations
    • [x] PATCH - Update Knowledge Base
  • [x] Documentation
  • [ ] Tests


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.


Bug reports and pull requests are welcome on GitHub at https://github.com/Birdie0/qna_maker. 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.


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

Code of Conduct

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