0.0
No commit activity in last 3 years
No release in over 3 years
API client of the karakuri.ai.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
~> 5.0
~> 10.0
 Project Readme

KarakuriAi

Build Status

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/karakuri_ai. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'karakuri_ai'

And then execute:

$ bundle

Or install it yourself as:

$ gem install karakuri_ai

Usage

KarakuriAi.configure do |config|
  config.api_key = 'your bearer token'
  config.account = 'your subdomain of karakuri.ai'
end

client = KarakuriAi::Client.new

# Or
client = KarakuriAi::Client.new(api_key: 'your bearer token', account: 'your subdomain of karakuri.ai')

resp = client.reply(query: 'message')
resp.most_confident_text
# => 'confident answer from karakuri.ai'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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/bank/karakuri_ai-ruby.

License

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