ai21 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d246c86807d3bcd6b2bafe31b34b6b426f9b4b89c28544cfb5abfce6204a9d0
-  data.tar.gz: 2006023a575aa77e4172bd8f2fae30384751427833a91ec813aa56102c5c434c
+  metadata.gz: 5215852a66432ed4fd3f8f1577e01f92aaccc2afd141728ef1b26a694c4c018b
+  data.tar.gz: 5adfec11c0ab7504bce0d31816228678f4f32573be47c167acdf622f0521adf4
 SHA512:
-  metadata.gz: cebbc69bcfab0c46090c7e7a443b2c49a9c7d7be74713d7a73e87bad8216a338b182f76f582287ab2715d18b75da1eddf222134600ceca7092022ac6fae965bc
-  data.tar.gz: 33a0182f3bca6897d4746f84cade3954b1d9638c94389fc6718215f5a85fd24ccf17ef9549ef48e8efaa856d7485ba1ea5f0e65464ed044b06fadb95dcea894c
+  metadata.gz: 6ff6db10c500f5f770ad45f6dbc05b03afce008b7ce0f0c062077d3e500295a57a818547223067adc2475165d7e86b39ff3b915cb65c7379f24c5acc1fd4ee44
+  data.tar.gz: 9f0eda1cd97e621d7237d1fef349cda23b4047a0a7bf4c0706f3482df2bd32e44669bf6aeb39f131f0ad5b4063bf074d3b521f1ec0980330f39a5a43bfbdefd7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ai21 (0.1.0)
+    ai21 (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alex Chaplinsky
+
+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

@@ -1,24 +1,87 @@
-# Ai21
+# Ruby client for AI21
 
-TODO: Delete this and the text below, and describe your gem
-
-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/ai21`. To experiment with that code, run `bin/console` for an interactive prompt.
+Use the [Studio AI21](https://www.ai21.com/studio) API with Ruby! Differentiate your product with generative text AI :robot:.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+### Gem install
+Install gem with:
+
+```
+gem install ai21
+```
+
+and require with:
+
+```ruby
+require "ai21"
+```
+
+### Bundler
+Add gem to your application's `Gemfile`:
+
+```ruby
+gem "ai21"
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```
+bundle install
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Getting Started
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+- Sign up for AI21 Studio here https://studio.ai21.com/sign-up
+- Get your API key from https://studio.ai21.com/account/api-key
+- Refer to [AI21 API doc](https://docs.ai21.com/reference/) to understand options that can be passed to different tasks
 
 ## Usage
 
-TODO: Write usage instructions here
+Instantiate a client
+```ruby
+client = AI21::Client.new "YOUR_API_TOKEN"
+```
+
+#### Completion
+```ruby
+client.complete("The capital of France is ")
+```
+
+#### Intstruct
+```ruby
+client.instruct("Tell me the name of main character in 'The Matrix'")
+```
+
+#### Paraphrase
+```ruby
+client.paraphrase("there is nothing that can't be fixed")
+```
+
+#### Correction
+```ruby
+client.correct("can you fix this speling mistake?")
+```
+
+#### Improvements
+```ruby
+client.improvements("This is a bad decision to let AI control the world")
+```
+
+#### Summarization
+```ruby
+client.summarize("Long text that requires summarization ...")
+```
+
+#### Question Answering
+```ruby
+client.answer("what is the capital of France?", "Capital of France is the city called Paris")
+```
+
+#### Tokenize
+```ruby
+client.tokenize("Lorem ipsum long long tokens!")
+```
 
 ## Development
 
@@ -28,8 +91,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ai21. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ai21/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/alchaplinsky/ai21. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/alchaplinsky/ai21/blob/main/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the Ai21 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ai21/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ai21 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alchaplinsky/ai21/blob/main/CODE_OF_CONDUCT.md).

data/lib/ai21/client.rb

@@ -32,22 +32,26 @@ module AI21
       AI21::Client.post("/gec", {text: prompt})
     end
 
-    def improvements(prompt, types, options = {})
-      AI21::Client.post("/improvements", {text: prompt, types: types}.merge(snake_to_camel(options)))
+    def improvements(prompt, types = ["fluency"])
+      AI21::Client.post("/improvements", {text: prompt, types: types})
     end
 
-    def summarize(prompt, source_type, options = {})
+    def summarize(prompt, source_type = "TEXT", options = {})
       AI21::Client.post("/summarize", {source: prompt, sourceType: source_type}.merge(snake_to_camel(options)))
     end
 
-    def segmentation(prompt, source_type, options = {})
-      AI21::Client.post("/segmentation", {source: prompt, sourceType: source_type}.merge(snake_to_camel(options)))
+    def segmentation(prompt, source_type = "TEXT")
+      AI21::Client.post("/segmentation", {source: prompt, sourceType: source_type})
     end
 
     def answer(question, context)
       AI21::Client.post("/experimental/answer", {question: question, context: context})
     end
 
+    def tokenize(text)
+      AI21::Client.post("/tokenize", {text: text})
+    end
+
     def dataset
       @dataset ||= AI21::Dataset.new
     end

data/lib/ai21/http.rb

@@ -4,42 +4,44 @@ require "uri"
 require "net/http"
 require "openssl"
 require "json"
-require "pry"
 
 module AI21
   module HTTP
     include AI21::Helper
 
     def get(path)
-      url = URI("#{AI21.configuration.uri_base}#{AI21.configuration.api_version}#{path}")
-      http = http(url)
-      request = get_request(url)
-      body = http.request(request).read_body
-      camel_to_snake ::JSON.parse(body)
+      fetch(path, :get)
     end
 
     def post(path, body)
-      url = URI("#{AI21.configuration.uri_base}#{AI21.configuration.api_version}#{path}")
+      fetch(path, :post, body)
+    end
+
+    def delete(path)
+      fetch(path, :delete)
+    end
+
+    def fetch(path, method, body = nil)
+      url = url(path)
       http = http(url)
-      request = post_request(url, body)
+      request = request(url, method)
+
+      request.body = body.to_json if body
+
       body = http.request(request).read_body
       camel_to_snake ::JSON.parse(body)
     end
 
-    def get_request(url)
-      request = Net::HTTP::Get.new(url)
-      request["accept"] = "application/json"
-      request["Authorization"] = "Bearer #{AI21.configuration.access_token}"
+    def request(url, method)
+      request = Object.const_get("Net::HTTP::#{method.capitalize}").new(url)
+      request["accept"] = content_type
+      request["content-type"] = content_type
+      request["Authorization"] = authorization
       request
     end
 
-    def post_request(url, body)
-      request = Net::HTTP::Post.new(url)
-      request["accept"] = "application/json"
-      request["content-type"] = "application/json"
-      request["Authorization"] = "Bearer #{AI21.configuration.access_token}"
-      request.body = body.to_json
-      request
+    def url(path)
+      URI("#{AI21.configuration.uri_base}#{AI21.configuration.api_version}#{path}")
     end
 
     def http(url)
@@ -47,5 +49,13 @@ module AI21
       http.use_ssl = true
       http
     end
+
+    def authorization
+      "Bearer #{AI21.configuration.access_token}"
+    end
+
+    def content_type
+      "application/json"
+    end
   end
 end

data/lib/ai21/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AI21
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai21
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alex Chaplinsky
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies: []
 description: Ruby client for AI21 Studio API.
 email:
@@ -22,6 +22,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - lib/ai21.rb