chatgpt-rb 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50e30e865ade9a6e20cad5680617972114a224bda8bf25d9969b9b57e6236763
-  data.tar.gz: e7d1714512f1696b9401018b11292a46ed220c650639521def9b4fa0290303a0
+  metadata.gz: 3f4e1f6a8aea8a8fa06d4ebe9c35da19c8e7813c945a1ce534eeadd0e5088282
+  data.tar.gz: 611a070396c1c5006bd3df9b961dc2b2ed1a0fd3259626b4b38edbc2c08337c1
 SHA512:
-  metadata.gz: a42400a64dee74e93b7b27c8d04fc1f8c750bd0b90abc1ba37c33bdd58cbc9a494906c544b2bb0e02585807fffffbaae9ff3488d328b9bdb3051cc4fbfb59c0b
-  data.tar.gz: 4f187489399450e128b1f5f1634004be8de0a5f4b71516bff12ec234e3cf5cf3498102d6e44081e0e2bd00dc8ad14c1f75ca68770425eac0a7b1e32d284ee6e4
+  metadata.gz: b2d583053bfb3700bda25d4416796997ce24c8acfd053deb34a639119b48aea90e555acb0edf4fd8c002e72716eb195629ee1b913ab6db06511d65457431c618
+  data.tar.gz: 3dc0bcfb0bb3eabc87972722ff617431349634c501406a02eada63bf61d03df5c9b05c515759db76e6ea119d85c7325781a8887f51ec802bde108eae15cb1e59

data/bin/chatgpt-rb

@@ -3,6 +3,7 @@
 require "dotenv/load"
 require "colorize"
 require "reline"
+require "optparse"
 require_relative "./../lib/chatgpt_rb"
 
 begin
@@ -10,17 +11,85 @@ begin
 rescue
 end
 
+options = {
+  key: ENV["OPEN_AI_KEY"],
+  model: "gpt-3.5-turbo",
+  base_uri: "https://api.openai.com/v1",
+  functions_files: [],
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: chatgpt-rb [options]"
+
+  opts.on("-f", "--file FILE", "Load a previous conversation from FILE") do |file|
+    options[:file] = file
+  end
+
+  opts.on("-k", "--api-key KEY", "Use the provided API key for authentication") do |key|
+    options[:key] = key
+  end
+
+  opts.on("-m", "--model MODEL", "Use the provided MODEL (Default: #{options[:model]})") do |model|
+    options[:model] = model
+  end
+
+  opts.on("-b", "--base-uri URI", "Use the provided base URI (Default: #{options[:base_uri]})") do |uri|
+    options[:base_uri] = uri
+  end
+
+  opts.on("-u", "--functions-file FILE", "Add functions defined in FILE to your conversation") do |functions_file|
+    options[:functions_files] << functions_file
+  end
+
+  opts.on("-p", "--prompt PROMPT", "Declare the PROMPT for your conversation") do |prompt|
+    options[:prompt] = prompt
+  end
+end.parse!
+
 begin
-  conversation = ChatgptRb::Conversation.new(api_key: ENV.fetch("OPEN_AI_KEY"), model: ENV.fetch("OPEN_AI_MODEL", "gpt-3.5-turbo"))
+  puts "Type any message to talk with ChatGPT. Type '\\help' for a list of commands."
+
+  functions = options[:functions_files].flat_map do |function_file|
+              puts "Loading functions from #{function_file}"
+
+              ChatgptRb::Conversation.new.tap do |conversation|
+                ChatgptRb::DSL::Conversation.new(conversation).instance_eval(File.read(function_file))
+              end.functions.values
+            end
+
+  messages = if options[:file]
+               JSON.parse(File.read(options[:file])).map { |hash| hash.transform_keys(&:to_sym) }
+             else
+               []
+             end
+
+  if options[:prompt]
+    puts "prompt> ".colorize(:blue) + options[:prompt]
+  end
 
-  puts "Type any message to talk with ChatGPT. Type 'exit' to quit. Type 'dump' to dump this conversation to JSON."
+  conversation = ChatgptRb::Conversation.new(api_key: options.fetch(:key), model: options.fetch(:model), base_uri: options.fetch(:base_uri), messages:, functions:, prompt: options[:prompt])
 
   while message = Reline.readline("me> ".colorize(:red), true) do
     case message.chomp
-    when "exit", "quit", "q", "\\q"
+    when "\\help", "\\h"
+      puts <<~COMMANDS.colorize(:blue)
+        - `\\quit` Exit
+        - `\\save <filename>` Save this conversation to a JSON file that can be reloaded later with the `-f` argument
+        - `\\functions` Get a list of configured functions
+      COMMANDS
+    when "\\q", "\\quit", "\\exit"
       exit
-    when "dump"
+    when "\\dump"
       puts "dump> ".colorize(:blue) + conversation.messages.to_json
+    when "\\functions"
+      puts "available functions:".colorize(:blue)
+      functions.each do |function|
+        puts "- `#{function.name}` #{function.description}".colorize(:blue)
+      end
+    when /^\\save .+/
+      filename = /^\\save (.+)/.match(message)[1]
+      File.open(filename, "w") { |f| f.write(conversation.messages.to_json) }
+      puts "saved to #{filename} ".colorize(:blue)
     else
       print("ai> ".colorize(:yellow))
       conversation.ask(message) { |fragment| print(fragment) }

data/lib/chatgpt_rb/conversation.rb

@@ -1,14 +1,11 @@
 require "httparty"
+require "json-schema"
 require_relative "./function"
 require_relative "./dsl/conversation"
 
 module ChatgptRb
   class Conversation
-    include HTTParty
-
-    base_uri "https://api.openai.com"
-
-    attr_accessor :api_key, :model, :functions, :temperature, :max_tokens, :top_p, :frequency_penalty, :presence_penalty, :prompt
+    attr_accessor :api_key, :model, :functions, :temperature, :max_tokens, :top_p, :frequency_penalty, :presence_penalty, :prompt, :base_uri
     attr_reader :messages
 
     # @param api_key [String]
@@ -21,7 +18,8 @@ module ChatgptRb
     # @param presence_penalty [Float]
     # @param messages [Array<Hash>]
     # @param prompt [String, nil] instructions that the model can use to inform its responses, for example: "Act like a sullen teenager."
-    def initialize(api_key: nil, model: "gpt-3.5-turbo", functions: [], temperature: 0.7, max_tokens: 1024, top_p: 1.0, frequency_penalty: 0.0, presence_penalty: 0.0, messages: [], prompt: nil, &configuration)
+    # @param base_uri [String]
+    def initialize(api_key: nil, model: "gpt-3.5-turbo", functions: [], temperature: 0.7, max_tokens: 1024, top_p: 1.0, frequency_penalty: 0.0, presence_penalty: 0.0, messages: [], prompt: nil, base_uri: "https://api.openai.com/v1", &configuration)
       @api_key = api_key
       @model = model
       @functions = functions.each_with_object({}) do |function, hash|
@@ -33,10 +31,11 @@ module ChatgptRb
       @top_p = top_p
       @frequency_penalty = frequency_penalty
       @presence_penalty = presence_penalty
-      @messages = messages
+      @messages = messages.map { |message| message.transform_keys(&:to_sym) }
       @prompt = prompt
+      @base_uri = base_uri
       ChatgptRb::DSL::Conversation.configure(self, &configuration) if block_given?
-      @messages << { role: "system", content: prompt } if prompt
+      @messages.unshift(role: "system", content: prompt) if prompt
     end
 
     # @param content [String]
@@ -64,7 +63,18 @@ module ChatgptRb
       @messages << message
     end
 
+    # Ensure that each function's argument declarations conform to the JSON Schema
+    # See https://github.com/voxpupuli/json-schema/
+    def validate_functions!
+      metaschema = JSON::Validator.validator_for_name("draft4").metaschema
+      functions.values.each do |function|
+        raise ArgumentError, "Invalid function declaration for #{function.name}: #{function.as_json}" unless JSON::Validator.validate(metaschema, function.as_json)
+      end
+    end
+
     def get_next_response(&block)
+      validate_functions!
+
       streamed_content = ""
       streamed_arguments = ""
       streamed_role = ""
@@ -84,8 +94,8 @@ module ChatgptRb
         hash[:functions] = functions.values.map(&:as_json) unless functions.empty?
       end
 
-      response = self.class.post(
-        "/v1/chat/completions",
+      response = HTTParty.post(
+        "#{base_uri}/chat/completions",
         steam_body: block_given?,
         headers: {
           "Content-Type" => "application/json",
@@ -97,11 +107,12 @@ module ChatgptRb
       ) do |fragment|
         if block_given?
           fragment.each_line do |line|
-            next if line.nil?
-            next if line == "\n"
             break if line == "data: [DONE]\n"
 
-            line_without_prefix = line.gsub(/^data: /, "")
+            line_without_prefix = line.gsub(/^data: /, "").rstrip
+
+            next if line_without_prefix.empty?
+
             json = JSON.parse(line_without_prefix)
 
             break if json.dig("choices", 0, "finish_reason")
@@ -131,17 +142,17 @@ module ChatgptRb
       error_buffer.each { |e| $stderr.puts("Error: #{e}") }
 
       @messages << if block_given? && streamed_content != ""
-                     { "content" => streamed_content, "role" => streamed_role }
+                     { content: streamed_content, role: streamed_role }
                    elsif block_given? && streamed_arguments != ""
-                     { "role" => "assistant", "content" => nil, "function_call" => { "name" => streamed_function, "arguments" => streamed_arguments } }
+                     { role: "assistant", content: nil, function_call: { "name" => streamed_function, "arguments" => streamed_arguments } }
                    else
-                     response.dig("choices", 0, "message")
+                     response.dig("choices", 0, "message").transform_keys(&:to_sym)
                    end
 
-      if @messages.last["content"]
-        @messages.last["content"]
-      elsif @messages.last["function_call"]
-        function_args = @messages.last["function_call"]
+      if @messages.last[:content]
+        @messages.last[:content]
+      elsif @messages.last[:function_call]
+        function_args = @messages.last[:function_call]
         function_name = function_args.fetch("name")
         arguments = JSON.parse(function_args.fetch("arguments"))
         function = functions[function_name]

data/lib/chatgpt_rb/function.rb

@@ -2,11 +2,11 @@ module ChatgptRb
   class Function
     attr_accessor :name, :description, :parameters, :implementation
 
-    # @param name [String]
+    # @param name [String, nil]
     # @param description [String, nil]
     # @param parameters [Array<ChatgptRb::Parameter>]
     # @param implementation [Lambda, nil]
-    def initialize(name:, description: nil, parameters: [], implementation: nil)
+    def initialize(name: nil, description: nil, parameters: [], implementation: nil)
       @name = name
       @description = description
       @parameters = parameters

data/lib/chatgpt_rb/version.rb

@@ -0,0 +1,3 @@
+module ChatgptRb
+  VERSION = "0.1.3"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatgpt-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Aaron Breckenridge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-08 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Provides libraries for interacting with the ChatGPT API and a CLI program
-  `chatgpt-rb` for live conversations.
+  `chatgpt-rb` for live conversations. Supports writing functions in Ruby.
 email:
 - aaron@breckridge.dev
 executables:
@@ -127,6 +141,7 @@ files:
 - lib/chatgpt_rb/dsl/parameter.rb
 - lib/chatgpt_rb/function.rb
 - lib/chatgpt_rb/parameter.rb
+- lib/chatgpt_rb/version.rb
 homepage: https://github.com/breckenedge/chatgpt-rb
 licenses:
 - MIT