gen-ai 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a51511a0ca7cd09a4505151799e5d797d87d4418bb4a250e0436fab78317ac1b
-  data.tar.gz: 1719adc9ca432e9da3420492651ea3ef2a10b7f990fe3607c28cf8187f4c6811
+  metadata.gz: 20e16166f4ff21fb5130cf198be040b3d89019ba18cebd55e25f02720b32de62
+  data.tar.gz: 0eb3c0b7aace3f1dc97cc6f28635b45dae67aac3304d9fc9926a2f6a517d42cf
 SHA512:
-  metadata.gz: f482fba1992856a4009aabdebd849cf245d8069426da935999c3cbb323b02a36e916c2ab299c6fffd0ba7e5c320ddda001a9abb625063ea9c8a202376151f225
-  data.tar.gz: 155f5f3e8d9b5c0234075635d4623300c0dcbed2fb63b2a8ee4bf2199a5bb75a6dbe8d864028078e5275b72c79a05836c7e26a4b4f49e179d80744caa8dd881d
+  metadata.gz: '02380f33e49b058b40c62c07b2470d5cebb36e8301f4d985077fbd27c9279948cf981227b6f8293bcac74a7b455f17e0ce64310601afcc7cfcd4bf81e3293fee'
+  data.tar.gz: 51e6bd0e3950fa62ae26f7f4103fbdd457e262212a840a9dab3abf84ed8337a6f50b60f011fbc717b891b4ac78483cbc60224784f4dfc78cdc7b938ac29f22a6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+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,160 @@
-# Gen::Ai
+# GenAI
 
-TODO: Delete this and the text below, and describe your gem
+✨ Generative AI toolset for Ruby ✨
 
-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/gen/ai`. To experiment with that code, run `bin/console` for an interactive prompt.
+GenAI allows you to easily integrate Generative AI model providers like OpenAI, Google Vertex AI, Stability AI, etc. Easily add Large Language Models, Stable Diffusion image generation, and other AI models into your application!
 
-## Installation
+![Tests](https://github.com/alchaplinsky/gen-ai/actions/workflows/main.yml/badge.svg?branch=main)
+[![Gem Version](https://badge.fury.io/rb/gen-ai.svg)](https://badge.fury.io/rb/gen-ai)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/alchaplinsky/gen-ai/blob/main/LICENSE.txt)
 
-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.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add gen-ai
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install gen-ai
 
 ## Usage
 
-TODO: Write usage instructions here
+### Feature support
+✅ - Supported  |  ❌ - Not supported  |  🛠️ - Work in progress
+
+Language models capabilities
+
+| Provider         | Embedding | Completion | Conversation | Sentiment | Summarization |
+| ---------------- | --------- | :--------: | :----------: | :-------: | :-----------: |
+| **OpenAI**       | ✅        | ✅         | ✅            | 🛠️        | 🛠️             |
+| **Google Palm2** | ✅        | ✅         | ✅            | 🛠️        | 🛠️             |
+
+
+Image generation model capabilities 
+
+| Provider         | Generate  | Variations | Edit         | Upscale   |
+| ---------------- | --------- | :--------: | :----------: | :-------: |
+| **OpenAI**       | ✅        | ✅         | ✅            | ❌        |
+| **StabilityAI**  | ✅        | ❌         | ✅            | 🛠️        |
+
+### Language
+
+Instantiate a language model client by passing a provider name and an API token.
+
+```ruby
+model = GenAI::Language.new(:open_ai, ENV['OPEN_AI_TOKEN'])
+```
+
+Generate **embedding(s)** for text using provider/model that fits your needs
+
+```ruby
+result = model.embed('Hi, how are you?')
+# => #<GenAI::Result:0x0000000110be6f20...>
+
+result.value
+# =>  [-0.013577374, 0.0021624255, 0.0019274801, ... ]
+
+result = model.embed(['Hello', 'Bonjour', 'Cześć'])
+# => #<GenAI::Result:0x0000000110be6f34...>
+
+result.values
+# =>  [[-0.021834826, -0.007176527, -0.02836839,, ... ], [...], [...]]
+```
+
+Generate text **completions** using Large Language Models
+
+```ruby
+result = model.complete('London is a ', temperature: 0, max_tokens: 11)
+# => #<GenAI::Result:0x0000000110be6d21...>
+
+result.value
+# => "vibrant and diverse city located in the United Kingdom"
+
+
+result = model.complete('London is a ', max_tokens: 12, n: 2)
+# => #<GenAI::Result:0x0000000110c25c70...>
+
+result.values
+# => ["thriving, bustling city known for its rich history.", "major global city and the capital of the United Kingdom."]
+
+```
+
+Have a **conversation** with Large Language Model.
+
+```ruby
+result = model.chat('Hi, how are you?')
+# = >#<GenAI::Result:0x0000000106ff3d20...>
+
+result.value
+# => "Hello! I'm an AI, so I don't have feelings, but I'm here to help. How can I assist you today?"
+
+history = [
+    {role: 'user', content: 'What is the capital of Great Britain?'},
+    {role: 'assistant', content: 'London'},
+]
+
+result = model.chat("what about France?", history: history)
+# => #<GenAI::Result:0x00000001033c3bc0...>
+
+result.value
+# => "Paris"
+```
+
+### Image
+
+Instantiate a image generation model client by passing a provider name and an API token.
+
+```ruby
+model = GenAI::Image.new(:open_ai, ENV['OPEN_AI_TOKEN'])
+```
+
+Generate **image(s)** using provider/model that fits your needs
+
+```ruby
+result = model.generate('A painting of a dog')
+# => #<GenAI::Result:0x0000000110be6f20...>
+
+result.value
+# => Base64 encoded image
+
+# Save image to file
+File.open('dog.jpg', 'wb') do |f|
+  f.write(Base64.decode64(result.value))
+end
+```
+
+Get more **variations** of the same image
+
+```ruby
+result = model.variations('./dog.jpg')
+# => #<GenAI::Result:0x0000000116a1ec50...>
+
+result.value
+# => Base64 encoded image
+
+# Save image to file
+File.open('dog_variation.jpg', 'wb') do |f|
+  f.write(Base64.decode64(result.value))
+end
+
+```
+
+**Editing** existing images with additional prompt
+
+```ruby
+result = model.edit('./llama.jpg', 'A cute llama wearing a beret', mask: './mask.png')
+# => #<GenAI::Result:0x0000000116a1ec50...>
+
+result.value
+# => Base64 encoded image
+
+# Save image to file
+File.open('dog_edited.jpg', 'wb') do |f|
+  f.write(Base64.decode64(result.value))
+end
+
+```
 
 ## Development
 
@@ -28,8 +164,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]/gen-ai. 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]/gen-ai/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/alchaplinsky/gen-ai. 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/gen-ai/blob/main/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the Gen::Ai project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gen-ai/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the GenAI project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/alchaplinsky/gen-ai/blob/main/CODE_OF_CONDUCT.md).

data/gen-ai.gemspec

@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'faraday', '~> 2.7'
+  spec.add_dependency 'faraday-multipart'
   spec.add_dependency 'zeitwerk', '~> 2.6'
 
   spec.add_development_dependency 'google_palm_api', '~> 0.1'

data/lib/gen_ai/api/client.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+
+module GenAI
+  module Api
+    class Client
+      def initialize(url:, token:)
+        @url = url
+        @token = token
+      end
+
+      def post(path, body, options = {})
+        multipart = options.delete(:multipart) || false
+        payload = multipart ? body : JSON.generate(body)
+
+        handle_response do
+          connection(multipart: multipart).post(path, payload)
+        end
+      end
+
+      def get(path, options)
+        handle_response do
+          connection.get(path, options)
+        end
+      end
+
+      private
+
+      attr_reader :url, :token
+
+      def connection(multipart: false)
+        Faraday.new(url: url, headers: {
+          'Accept' => 'application/json',
+          'Content-Type' => multipart ? 'multipart/form-data' : 'application/json',
+          'Authorization' => "Bearer #{token}"
+        }) do |conn|
+          conn.request :multipart if multipart
+          conn.request :url_encoded
+        end
+      end
+
+      def handle_response
+        response = yield
+
+        raise GenAI::ApiError, "API error: #{JSON.parse(response.body)}" unless response.success?
+
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/gen_ai/base.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module GenAI
+  class Base
+    include GenAI::Dependency
+
+    private
+
+    attr_reader :client
+
+    def handle_errors
+      response = yield
+      return if !response || response.empty?
+
+      raise GenAI::ApiError, "#{api_provider_name} API error: #{response.dig('error', 'message')}" if response['error']
+
+      response
+    end
+
+    def provider_name
+      api_provider_name.gsub(/(.)([A-Z])/, '\1_\2').downcase
+    end
+
+    def api_provider_name
+      self.class.name.split('::').last
+    end
+
+    def build_result(model:, raw:, parsed:)
+      GenAI::Result.new(provider: provider_name.to_sym, model: model, raw: raw, values: parsed)
+    end
+  end
+end

data/lib/gen_ai/image/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GenAI
+  class Image
+    class Base < GenAI::Base
+      def generate(...)
+        raise NotImplementedError, "#{self.class.name} does not support generate"
+      end
+
+      def variations(...)
+        raise NotImplementedError, "#{self.class.name} does not support variations"
+      end
+    end
+  end
+end

data/lib/gen_ai/image/open_ai.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module GenAI
+  class Image
+    class OpenAI < Base
+      DEFAULT_SIZE = '256x256'
+      RESPONSE_FORMAT = 'b64_json'
+
+      def initialize(token:, options: {})
+        depends_on 'ruby-openai'
+
+        @client = ::OpenAI::Client.new(access_token: token)
+      end
+
+      def generate(prompt, options = {})
+        parameters = build_generation_options(prompt, options)
+
+        response = handle_errors { @client.images.generate(parameters: parameters) }
+
+        build_result(
+          raw: response,
+          model: 'dall-e',
+          parsed: response['data'].map { |datum| datum[RESPONSE_FORMAT] }
+        )
+      end
+
+      def variations(image, options = {})
+        parameters = build_variations_options(image, options)
+
+        response = handle_errors { @client.images.variations(parameters: parameters) }
+
+        build_result(
+          raw: response,
+          model: 'dall-e',
+          parsed: response['data'].map { |datum| datum[RESPONSE_FORMAT] }
+        )
+      end
+
+      def edit(image, prompt, options = {})
+        parameters = build_edit_options(image, prompt, options)
+
+        response = handle_errors { @client.images.edit(parameters: parameters) }
+
+        build_result(
+          raw: response,
+          model: 'dall-e',
+          parsed: response['data'].map { |datum| datum[RESPONSE_FORMAT] }
+        )
+      end
+
+      private
+
+      def build_generation_options(prompt, options)
+        {
+          prompt: prompt,
+          size: options.delete(:size) || DEFAULT_SIZE,
+          response_format: options.delete(:response_format) || RESPONSE_FORMAT
+        }.merge(options)
+      end
+
+      def build_variations_options(image, options)
+        {
+          image: image,
+          size: options.delete(:size) || DEFAULT_SIZE,
+          response_format: options.delete(:response_format) || RESPONSE_FORMAT
+        }.merge(options)
+      end
+
+      def build_edit_options(image, prompt, options)
+        {
+          image: image,
+          prompt: prompt,
+          size: options.delete(:size) || DEFAULT_SIZE,
+          response_format: options.delete(:response_format) || RESPONSE_FORMAT
+        }.merge(options)
+      end
+    end
+  end
+end

data/lib/gen_ai/image/stability_ai.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module GenAI
+  class Image
+    class StabilityAI < Base
+      DEFAULT_SIZE = '256x256'
+      API_BASE_URL = 'https://api.stability.ai'
+      DEFAULT_MODEL = 'stable-diffusion-xl-beta-v2-2-2'
+
+      def initialize(token:, options: {})
+        build_client(token)
+      end
+
+      def generate(prompt, options = {})
+        model = options[:model] || DEFAULT_MODEL
+        url = "/v1/generation/#{model}/text-to-image"
+
+        response = client.post url, build_generation_body(prompt, options)
+
+        build_result(
+          raw: response,
+          model: model,
+          parsed: response['artifacts'].map { |artifact| artifact['base64'] }
+        )
+      end
+
+      def edit(image, prompt, options = {})
+        model = options[:model] || DEFAULT_MODEL
+        url = "/v1/generation/#{model}/image-to-image"
+
+        response = client.post url, build_edit_body(image, prompt, options), multipart: true
+
+        build_result(
+          raw: response,
+          model: model,
+          parsed: response['artifacts'].map { |artifact| artifact['base64'] }
+        )
+      end
+
+      private
+
+      def build_client(token)
+        @client = GenAI::Api::Client.new(url: API_BASE_URL, token: token)
+      end
+
+      def build_generation_body(prompt, options)
+        w, h = size(options)
+
+        {
+          text_prompts: [{ text: prompt }],
+          height: h,
+          width: w
+        }.merge(options)
+      end
+
+      def build_edit_body(image, prompt, options)
+        {
+          init_image: File.binread(image),
+          'text_prompts[0][text]' => prompt,
+          'text_prompts[0][weight]' => 1.0
+        }.merge(options)
+      end
+
+      def size(options)
+        size = options.delete(:size) || DEFAULT_SIZE
+        size.split('x').map(&:to_i)
+      end
+    end
+  end
+end

data/lib/gen_ai/image.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GenAI
+  class Image
+    def initialize(provider, token, options: {})
+      build_client(provider, token, options)
+    end
+
+    def generate(prompt, options = {})
+      client.generate(prompt, options)
+    end
+
+    def variations(image, options = {})
+      client.variations(image, options)
+    end
+
+    def edit(image, prompt, options = {})
+      client.edit(image, prompt, options)
+    end
+
+    # def upscale; end
+
+    private
+
+    attr_reader :client
+
+    def build_client(provider, token, options)
+      klass = GenAI::Image.constants.find do |const|
+        const.to_s.downcase == provider.to_s.downcase.gsub('_', '')
+      end
+
+      raise UnsupportedProvider, "Unsupported Image provider '#{provider}'" unless klass
+
+      @client = GenAI::Image.const_get(klass).new(token: token, options: options)
+    end
+  end
+end

data/lib/gen_ai/language/base.rb

@@ -2,9 +2,7 @@
 
 module GenAI
   class Language
-    class Base
-      include GenAI::Dependency
-
+    class Base < GenAI::Base
       DEFAULT_ROLE = 'user'
 
       def embed(...)
@@ -18,29 +16,6 @@ module GenAI
       def chat(...)
         raise NotImplementedError, "#{self.class.name} does not support conversations"
       end
-
-      private
-
-      attr_reader :client
-
-      def handle_errors
-        response = yield
-        return if response.empty?
-
-        if response['error']
-          raise GenAI::ApiError, "#{api_provider_name} API error: #{response.dig('error', 'message')}"
-        end
-
-        response
-      end
-
-      def api_provider_name
-        self.class.name.split('::').last
-      end
-
-      def build_result(model:, raw:, parsed:)
-        GenAI::Result.new(provider: @provider, model: model, raw: raw, values: parsed)
-      end
     end
   end
 end

data/lib/gen_ai/language/google_palm.rb

@@ -11,7 +11,6 @@ module GenAI
       def initialize(token:, options: {})
         depends_on 'google_palm_api'
 
-        @provider = :google_palm
         @client = ::GooglePalmApi::Client.new(api_key: token)
       end
 

data/lib/gen_ai/language/open_ai.rb

@@ -8,7 +8,7 @@ module GenAI
 
       def initialize(token:, options: {})
         depends_on 'ruby-openai'
-        @provider = :openai
+
         @client = ::OpenAI::Client.new(access_token: token)
       end
 

data/lib/gen_ai/result.rb

@@ -33,7 +33,11 @@ module GenAI
     private
 
     def usage
-      raw['usage']
+      raw['usage'] || {
+        'prompt_tokens' => nil,
+        'completion_tokens' => nil,
+        'total_tokens' => nil
+      }
     end
   end
 end

data/lib/gen_ai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GenAI
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/gen_ai.rb

@@ -4,7 +4,11 @@ require 'zeitwerk'
 require 'pry'
 
 loader = Zeitwerk::Loader.for_gem
-loader.inflector.inflect('gen_ai' => 'GenAI', 'open_ai' => 'OpenAI')
+loader.inflector.inflect(
+  'gen_ai' => 'GenAI',
+  'open_ai' => 'OpenAI',
+  'stability_ai' => 'StabilityAI'
+)
 loader.setup
 
 module GenAI

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: gen-ai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Chaplinsky
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2023-10-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -63,11 +91,18 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- LICENSE
 - README.md
 - Rakefile
 - gen-ai.gemspec
 - lib/gen_ai.rb
+- lib/gen_ai/api/client.rb
+- lib/gen_ai/base.rb
 - lib/gen_ai/dependency.rb
+- lib/gen_ai/image.rb
+- lib/gen_ai/image/base.rb
+- lib/gen_ai/image/open_ai.rb
+- lib/gen_ai/image/stability_ai.rb
 - lib/gen_ai/language.rb
 - lib/gen_ai/language/base.rb
 - lib/gen_ai/language/google_palm.rb