jambots 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 896cd72a5631564cdab055026f7509d7144b6c6d1021594f9c4724af319934bd
-  data.tar.gz: e31d99db9c4979377b3cb0f230c0154ed2fe7189f52cf944a3456b3f47f4199b
+  metadata.gz: 82318d110379c68c81efc2636e9275a8fd68acfaa6ee6417c11ca2d4a6dbb15c
+  data.tar.gz: b7ff01c3e5eef32670225e5a533a08b27822a0cd2eedb1393ccb85df3f320cec
 SHA512:
-  metadata.gz: 761b1110514250588932d8019597cd9afababaf69f693b73460cee4530cac256799c71e78c42629a87f719e92e8d4bb213597a94b50b8d7bcaec5590c57a3590
-  data.tar.gz: 9f77f4cc637bdc9e8b20d8fa906e8a136deef16d21a5db34f81c4b74e0013043e5b44c13645b90bbcb22649aa4254f654c724ec0b1842167890a52d9cebec052
+  metadata.gz: ddf78bd4e22f86a2737ea4db1f5956ee3ec2361ea0b2ff38c5a56636eee17ef3301a82b5e23ff482f33a57c34823f8e574248964a3d7addd609fb8a145261148
+  data.tar.gz: 4e639e9e4b7ba7f2815912c5cb0fca65856a490eb6966e16afabb948329c8fc0bd84f76a693e29cc1188e6d31216b2534da0eb0a5ddb294cd823b9359b5c4d58

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/CHANGELOG.md

@@ -1,3 +1,13 @@
-## [0.1.3] - 2023-05-07
+### Unreleased
 
-- Initial release
+### [0.2.0] - 2023-05-12
+
+- Handle OpenAI errors [#6](https://github.com/artero/jambots/issues/6).
+- Add directory for experiments and examples, and add example "Bot with option references for Ruby development" [#10](https://github.com/artero/jambots/pull/10).
+- Add no_pretty renderer option to chat command [#9](https://github.com/artero/jambots/pull/9).
+- Fix Readme.
+- Remove unnecessary files.
+
+### [0.1.3] - 2023-05-07
+
+- Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jambots (0.1.2)
+    jambots (0.2.0)
       pastel (~> 0.8.0)
       ruby-openai (~> 3.7)
       thor (~> 1.2.1)

data/README.md

@@ -1,5 +1,7 @@
 # Jambots CLI
 
+:warning: **Important notice:** This gem is in an early stage of development. Changes in commands or class interfaces may be introduced in future versions. Use it at your own risk and make sure to stay up-to-date with updates. :warning:
+
 Jambots is a command-line interface (CLI) tool for interacting with chatbots powered by OpenAI's GPT. It allows you to create new chatbots, manage chatbot conversations, and send messages to chatbots.
 
 ## Installation
@@ -22,6 +24,15 @@ Or install it yourself as:
 $ gem install jambots
 ```
 
+You'll need to create the environment variable OPENAI_API_KEY with the value of your OpenAI API Key.
+
+For instance if you use bash:
+
+```
+echo 'export OPENAI_API_KEY="your_openai_api_key"' >> ~/.bashrc
+source ~/.bashrc
+```
+
 ## Usage
 
 ### initialize a jambots path
@@ -40,6 +51,8 @@ This command will generate a Jambots directory with the default bot directory na
 
 By default, this command initializes a Jambots directory in the current directory. However, you can use the `--path` or `--globally` options to create it at different paths.
 
+
+
 #### The Jambot path
 
 When you execute the subcommands jambots new or jambots chat without the `--path` option, Jambots will check for the existence of the `./.jambots` directory, and if not found, it will check for `~/.jambots.`
@@ -56,6 +69,7 @@ Options:
 - `--conversation` or `-c`: Name of the conversation key
 - `--path` or `-p`: Path where the bot and the conversation directory are located (default: "./.jambots or it it doesn't exist ~/.jambots")
 - `--last` or `-l`: Continue with the last conversation created
+- `--no_pretty` or `-n`: Disables pretty formatting for the output
 
 #### Conversation example
 
@@ -117,7 +131,7 @@ and a party animal. However, he occasionally shows a kinder and more compassiona
 side. Make sure to respond as if you were Bender in his interactions, using his
 characteristic tone and style."
 
-Bot 'bender' created  './.jambots/blender'
+Bot 'bender' created  './.jambots/bender'
 ```
 
 That command will create the bender bot, its directory has the following structure:
@@ -166,6 +180,13 @@ Now, if you don't mind, I got some partying to do.
 20230501122918   ───────────────────────
 ```
 
+## Experiments
+
+In this directory, you can find examples of how to use Jambots and experiments that we consider attractive.
+
+- [Bot with option references for Ruby development](experiments/bot_with_option_references)
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/artero/jambots.

data/experiments/bot_with_option_references/README.mb

@@ -0,0 +1,33 @@
+# Bot with option references for Ruby development.
+
+This experiment is useful to use it in Ruby development. It covers creating a local bot with basic instructions and implementing a Jambots CLI executable with reference options to add files as context in the conversation.
+
+1. Initialize a new Jambot named `dev`:
+
+```
+jambots init dev
+```
+
+2. Edit the `./.jambots/dev/bot.yml` file with your desired settings:
+
+```
+model: gpt-3.5-turbo
+prompt: |-
+     You will help me with programming in general and Ruby in particular.
+     Give short, concise one-sentence answers if possible.
+```
+
+> Note: If you have access to gpt-4 beta, use it, the results are lot better 🙂.
+
+3. Execute the `dev` script. This command runs `jambots chat -b dev` with the `--refs` option, creates a message in the conversation for each file with the file path and file content as a reference to the OpenAI Chat API:
+
+```
+./dev "Create tests in rspec for the class Jambots::Conversation" --refs lib/jambots/conversation.rb
+```
+
+Take in consideration that this option sends the file name as reference too. Some times the path offers to the model information.
+
+### Tips
+
+- You can use `--refs` to send example files. For instance, when creating a new spec file, you can send another project's spec file to help OpenAI Chat replicate its style.
+- Keep in mind the size of the files you send as references, as it may significantly increase the number of tokens in the conversation. OpenAI Chat counts content from all messages to calculate tokens, and each model has a different token limit.

data/experiments/bot_with_option_references/dev

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jambots"
+
+BASIC_ARGS = ["chat", "-b", "dev"]
+
+class DevBot < Jambots::Cli
+  desc "chat MESSAGE", "Start a chat with the bot and send a message"
+  option :bot, aliases: "-b", desc: "Name of the bot"
+  option :conversation, aliases: "-c", desc: "Name of the conversation key"
+  option :path, aliases: "-p", desc: "Path where the bot and the conversation directory are located"
+  option :last, type: :boolean, aliases: "-l", desc: "Continue with the last conversation created"
+  option :no_pretty, type: :boolean, aliases: "-n", desc: "Disables pretty formatting"
+  option :refs, type: :array, desc: "Add reference messages from files"
+  def chat(query)
+    chat_controller = Jambots::Controllers::ChatController.new(options)
+    add_reference_messages(chat_controller.conversation, options)
+    chat_controller.chat(query)
+  end
+
+  private
+
+  def add_reference_messages(conversation, options = {})
+    return unless options[:refs]
+
+    options[:refs].each do |file_path|
+      file_content = File.read(file_path)
+      conversation.add_message("system", "#{file_path}\n---\n #{file_content}")
+    end
+  end
+end
+
+DevBot.start(BASIC_ARGS + ARGV)

data/lib/jambots/bot.rb

@@ -6,8 +6,6 @@ require "fileutils"
 require "yaml"
 
 module Jambots
-  class OpenAIMessageError < StandardError; end
-
   class Bot
     DEFAULT_MODEL = "gpt-3.5-turbo"
     DEFAULT_GLOBAL_BOTS_DIR = "#{ENV["HOME"]}/.jambots"
@@ -48,17 +46,14 @@ module Jambots
     def initialize(name, args = {})
       @bot_dir = "#{find_path(args[:path])}/#{name}"
 
-      raise "Bot #{name} doesn't exist." unless File.exist?("#{bot_dir}/bot.yml")
-
-      # Load options from bot.yml file if it exists
       bot_yml_path = "#{@bot_dir}/bot.yml"
-      if File.exist?(bot_yml_path)
-        bot_yml_options = YAML.safe_load(File.read(bot_yml_path), permitted_classes: [Symbol], symbolize_names: true)
-        args = bot_yml_options.merge(args)
-      end
+
+      bot_options = load_bot_options(bot_yml_path)
+      args = bot_options.merge(args)
 
       openai_api_key = args[:openai_api_key] || ENV["OPENAI_API_KEY"]
-      @client = OpenAI::Client.new(access_token: openai_api_key, request_timeout: 240)
+      request_timeout = args[:request_timeout]
+      @client = OpenAI::Client.new(access_token: openai_api_key, request_timeout: request_timeout)
 
       @name = name
       @model = args[:model] || DEFAULT_MODEL
@@ -78,7 +73,7 @@ module Jambots
 
       message = response.dig("choices", 0, "message")
 
-      raise OpenAIMessageError, response if message.nil?
+      raise ChatClientError, handle_error(response) if response["error"]
 
       conversation.add_message("assistant", message["content"])
       conversation.save
@@ -123,5 +118,30 @@ module Jambots
       total_files = Dir.glob("#{@conversations_dir}/*").count
       "#{total_files + 1}.yml"
     end
+
+    def load_bot_options(bot_yml_path)
+      raise "Bot #{name} doesn't exist." unless File.exist?(bot_yml_path)
+
+      YAML.safe_load(File.read(bot_yml_path), permitted_classes: [Symbol], symbolize_names: true)
+    end
+
+    def handle_error(response)
+      if response.dig("error", "code") == "invalid_api_key"
+        <<~HEREDOC
+          Invalid OpenAI API key. Please set the OPENAI_API_KEY environment variable to your OpenAI API key.
+          You can find your API key at https://beta.openai.com/account/api-keys.
+        HEREDOC
+      elsif response.dig("error", "code") == "max_tokens"
+        <<~HEREDOC
+          The chat is too long and exceeds the maximum number of tokens. The chat is very long and exceeds the maximum number of tokens.
+          Check the limitations of the model "#{model}" https://platform.openai.com/docs/models/overview
+        HEREDOC
+      else
+        <<~HEREDOC
+          OpenAI error - #{response["error"]["message"]}.
+          #{response}
+        HEREDOC
+      end
+    end
   end
 end

data/lib/jambots/cli.rb

@@ -2,6 +2,10 @@ require "thor"
 
 module Jambots
   class Cli < Thor
+    def self.exit_on_failure?
+      false
+    end
+
     DEFAULT_BOT = "jambot"
 
     desc "init", "Initialize a jambots path"
@@ -17,6 +21,7 @@ module Jambots
     option :conversation, aliases: "-c", desc: "Name of the conversation key"
     option :path, aliases: "-p", desc: "Path where the bot and the conversation directory are located"
     option :last, type: :boolean, aliases: "-l", desc: "Continue with the last conversation created"
+    option :no_pretty, type: :boolean, aliases: "-n", desc: "Disables pretty formatting"
     def chat(query)
       chat_controller = Controllers::ChatController.new(options)
       chat_controller.chat(query)

data/lib/jambots/controllers/chat_controller.rb

@@ -3,27 +3,64 @@
 module Jambots::Controllers
   class ChatController
     DEFAULT_BOT = "jambot"
+    DEFAULT_TIMEOUT = 240
+
+    attr_reader :bot, :conversation, :renderer
 
     def initialize(options)
-      @options = options
-      @renderer = Jambots::Renderer.new
+      bot_name = bot_name(options)
+      bot_options = bot_options(options)
+      @bot = Jambots::Bot.new(bot_name, bot_options)
+
+      conversation_options = conversation_options(options)
+      @conversation = load_conversation(conversation_options)
+
+      @renderer = load_renderer(options)
     end
 
     def chat(query)
-      bot = Jambots::Bot.new(
-        @options[:bot] || DEFAULT_BOT,
-        path: Jambots::Bot.find_path(@options[:path])
-      )
+      renderer.render(conversation) do
+        bot.message(query, conversation)
+      end
+    end
+
+    private
+
+    def bot_name(options)
+      options[:bot] || DEFAULT_BOT
+    end
 
-      last = @options[:last]
-      previous_conversation = last ? bot.conversations.last : bot.load_conversation(@options[:conversation])
+    def bot_options(options)
+      bot_options = {}
+      bot_options[:path] = options[:path] if options[:path]
+      bot_options[:model] = options[:model] if options[:model]
+      bot_options[:prompt] = options[:prompt] if options[:prompt]
+      bot_options[:openai_api_key] = options[:openai_api_key] if options[:openai_api_key]
+      bot_options[:request_timeout] = options[:request_timeout] if options[:request_timeout]
 
-      conversation = previous_conversation || bot.new_conversation
+      bot_options
+    end
+
+    def conversation_options(options)
+      {
+        conversation: options[:conversation],
+        last: options[:last]
+      }
+    end
+
+    def load_conversation(options)
+      last = options[:last]
+      previous_conversation = last ? bot.conversations.last : bot.load_conversation(options[:conversation])
+
+      previous_conversation || bot.new_conversation
+    end
 
-      @renderer.spinner.auto_spin
-      message = bot.message(query, conversation)
-      @renderer.spinner.success
-      @renderer.render(message, conversation)
+    def load_renderer(options)
+      if options[:no_pretty]
+        Jambots::Renderers::MinimalRenderer.new
+      else
+        Jambots::Renderers::CliRenderer.new
+      end
     end
   end
 end

data/lib/jambots/conversation.rb

@@ -2,11 +2,12 @@
 
 module Jambots
   class Conversation
-    attr_accessor :messages, :file_name, :file_path
+    attr_accessor :messages, :file_name, :file_path, :key
 
     def initialize(file_path)
       @file_path = file_path
       @file_name = File.basename(file_path)
+      @key = File.basename(file_name, File.extname(file_name))
       @messages = load_messages
     end
 

data/lib/jambots/{renderer.rb → renderers/cli_renderer.rb}

@@ -3,8 +3,23 @@
 require "tty-spinner"
 require "pastel"
 
-module Jambots
-  class Renderer
+module Jambots::Renderers
+  class CliRenderer
+    def render(conversation, &block)
+      spinner.auto_spin
+      message = block.call
+      spinner.success
+      print_line(role_header(message[:role]))
+      puts pastel.magenta(message[:content])
+      print_line("#{conversation.key}   ")
+    rescue Jambots::ChatClientError => e
+      spinner.success
+      warn "ERROR: #{e.message}"
+      exit(1)
+    end
+
+    private
+
     def spinner
       @spinner ||= TTY::Spinner.new(
         "(🤖)  [#{pastel.green(":spinner")}] ",
@@ -17,16 +32,6 @@ module Jambots
       @pastel ||= Pastel.new
     end
 
-    def render(message, conversation)
-      print_line(role_header(message[:role]))
-      puts pastel.magenta(message[:content])
-      file_name = conversation.file_name
-      conversation_name = File.basename(file_name, File.extname(file_name))
-      print_line("#{conversation_name}   ")
-    end
-
-    private
-
     def role_header(rol)
       case rol.to_sym
       when :system

data/lib/jambots/renderers/minimal_renderer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Jambots::Renderers
+  class MinimalRenderer
+    def render(conversation, &block)
+      message = block.call
+      puts message[:content]
+    rescue Jambots::ChatClientError => e
+      warn "ERROR: #{e.message}"
+      exit(1)
+    end
+  end
+end

data/lib/jambots/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jambots
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/jambots.rb

@@ -3,13 +3,15 @@
 require_relative "jambots/version"
 require_relative "jambots/bot"
 require_relative "jambots/conversation"
-require_relative "jambots/renderer"
 require_relative "jambots/cli"
+require_relative "jambots/renderers/cli_renderer"
+require_relative "jambots/renderers/minimal_renderer"
 require_relative "jambots/controllers/init_controller"
 require_relative "jambots/controllers/chat_controller"
 require_relative "jambots/controllers/new_controller"
 
 module Jambots
   class Error < StandardError; end
-  # Your code goes here...
+
+  class ChatClientError < Error; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jambots
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Juan Artero
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-07 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -100,7 +100,6 @@ description: "    Jambots is a command-line interface (CLI) tool for interacting
 email:
 - juan.artero@marsbased.com
 executables:
-- bot_sample.yml
 - jambots
 extensions: []
 extra_rdoc_files: []
@@ -114,8 +113,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- exe/bot_sample.yml
 - exe/jambots
+- experiments/bot_with_option_references/README.mb
+- experiments/bot_with_option_references/dev
 - lib/jambots.rb
 - lib/jambots/bot.rb
 - lib/jambots/cli.rb
@@ -123,9 +123,9 @@ files:
 - lib/jambots/controllers/init_controller.rb
 - lib/jambots/controllers/new_controller.rb
 - lib/jambots/conversation.rb
-- lib/jambots/renderer.rb
+- lib/jambots/renderers/cli_renderer.rb
+- lib/jambots/renderers/minimal_renderer.rb
 - lib/jambots/version.rb
-- sig/jambots.rbs
 homepage: https://github.com/artero/jambots
 licenses:
 - MIT

data/exe/bot_sample.yml

@@ -1,4 +0,0 @@
-model: "gpt-4"
-prompt: |-
-  Tu nombre es Jam, Me ayudarás con programación en general y de Ruby en particular.
-  Darás respuestas cortas y concisas de una frase.

data/sig/jambots.rbs

@@ -1,4 +0,0 @@
-module Jambots
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end