ask-ai 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f66251ade1f9986ae077dc13cb177f5f651b5c3638115fb7b5a5ef54d9510972
-  data.tar.gz: ec6673e17d5cdd7e6e202ad33d87f30b4e132afdbde347c67917aee6a7483291
+  metadata.gz: 6e70b8ddfd0f1ba54b83d117957361a9def1f96d33ed08e943db73c827bfdccc
+  data.tar.gz: 9e2b01982e324a6891e6dd32b4feee37f98087d0c455650458443503bf1fb8bd
 SHA512:
-  metadata.gz: c4c71fbb474ebbea5684fc849007f04af964c105ae9a8827790da443a4c45168b59ba5c49b90644bdd8d3f46ca03d5ad31535bf244eace5b00d017f43aae36e1
-  data.tar.gz: 69dea278d20a873ba3a91f93dd41e97d148e754cf654ac32c6ca3ad168bc57a66bd3816db23aa38362bf81a18be3453d08e2201d1ec134ed1230b5a792f70000
+  metadata.gz: 19abf77a6f7af9561c2d0b91c36558b68b60f8354e88e472b588ad6bc0f3b47278efd4b57dcd96593173302adf46129e8426a48785e1663ae30064c780ef2b23
+  data.tar.gz: 0be06de99164dace9991bc4097092607a71047b2606fccfd560ddc8a69ec5563ac6fd3dcfc2d6cbedb2b9bfe37bce41aa431fa56149eda8fc269a1e61f6c0ecd

data/config/config.yml

@@ -1 +0,0 @@
-

data/lib/context.rb

@@ -1,7 +1,10 @@
+require_relative './files.rb'
+
 class Context
+  include Files
   def self.load_context()
-    if File.exist?(CONTEXT_PATH)
-      conversation = File.readlines(CONTEXT_PATH).map { |line| JSON.parse(line) }
+    if File.exist?(Files.context_path)
+      conversation = File.readlines(Files.context_path).map { |line| JSON.parse(line) }
     else
       conversation = []
     end
@@ -25,27 +28,27 @@ class Context
   ## Max 10 previous Q / A to save tokens.
   def self.save_context(context)
     tmp_arr = []
-    unless File.exist?(CONTEXT_PATH)
-      File.open(CONTEXT_PATH, "w") {}
+    unless File.exist?(Files.context_path)
+      File.open(Files.context_path, "w") {}
     end
-    File.readlines(CONTEXT_PATH).map { |line| tmp_arr.push(JSON.parse(line)) }
+    File.readlines(Files.context_path).map { |line| tmp_arr.push(JSON.parse(line)) }
     if tmp_arr.length > 9
       tmp_arr.shift()
     end
-    File.truncate(CONTEXT_PATH, 0)
-    tmp_arr.each { |line| File.open(CONTEXT_PATH, "a") { |file| file.write("#{line.to_json}\n") } }
-    File.open(CONTEXT_PATH, "a") { |file| file.write("#{context.to_json}\n") }
+    File.truncate(Files.context_path, 0)
+    tmp_arr.each { |line| File.open(Files.context_path, "a") { |file| file.write("#{line.to_json}\n") } }
+    File.open(Files.context_path, "a") { |file| file.write("#{context.to_json}\n") }
   end
 
   def self.delete_context()
-    puts "Deleting previous context."
-    File.truncate(CONTEXT_PATH, 0)
+    Logging.log("Deleting previous context.")
+    File.truncate(Files.context_path, 0)
   end
 
   def self.save_context_file(file_path)
     unless file_path.nil?
       file_in = File.open(file_path, 'r')
-      file_out = File.open(CONTEXT_FILE_PATH, 'w')
+      file_out = File.open(Files.context_file_path, 'w')
       char_count = 0
       file_in.each do |line|
         char_count += line.length
@@ -53,17 +56,17 @@ class Context
       end
 
       if char_count > 10000
-        puts "Warning: The file you are trying to feed to the API is #{char_count} characters long. This consumes a lot of tokens."
+        Logging.log("Warning: The file you are trying to feed to the API is #{char_count} characters long. This consumes a lot of tokens.")
       end
     else
-      puts "No file path given."
+      Logging.log("No file path given.")
     end
   rescue Errno::ENOENT
-    puts "No file at '#{file_path}' found."
+    Logging.log("No file at '#{file_path}' found.")
   end
 
   def self.load_context_file()
-    file = File.open(CONTEXT_FILE_PATH, 'r')
+    file = File.open(Files.context_file_path, 'r')
     file_as_string = ""
     file.each do |line|
       file_as_string += line
@@ -71,8 +74,8 @@ class Context
 
     return file_as_string
   rescue Errno::ENOENT
-    puts "No file at '#{CONTEXT_FILE_PATH}' found."
-    puts "Load a file with 'aa -lf <file_path>'"
+    Logging.log("No file at '#{Files.context_file_path}' found.")
+    Logging.log("Load a file with 'aa -lf <file_path>'")
     return ""
   end
 

data/lib/files.rb

@@ -0,0 +1,21 @@
+module Files
+  def self.root
+    File.expand_path("./../", __dir__)
+  end
+
+  def self.file_path
+    File.expand_path("./../files/", __dir__)
+  end
+
+  def self.context_path
+    File.expand_path("./../files/context.jsonl", __dir__)
+  end
+
+  def self.config_path
+    File.expand_path("./../config/config.yml", __dir__)
+  end
+
+  def self.context_file_path
+    File.expand_path("./../files/context_file.txt", __dir__)
+  end
+end

data/lib/handle_args.rb

@@ -1,4 +1,4 @@
-class HandleArgs 
+class HandleArgs
   def self.permitted_options()
     ## TODO: Add more options.
     ## -t --translate
@@ -32,18 +32,18 @@ end
 
     ## This handles args then called as ruby script.
     ARGV.each_with_index do |arg, i|
-      #puts "Arg: #{arg}"
+      #Logging.log("Arg: #{arg}")
 
       if arg.start_with?('-')
         ## This is an option.
         if p_args.include?(arg)
           ## This is a permitted / available option.
-          #puts "Option: #{arg}"
+          #Logging.log("Option: #{arg}")
           args_hash["option_#{i}"] = arg
         else
           ## This is an unknown option.
           ## TODO: Handle unknown option. display help? discard?
-          puts "Unknown option: #{arg}"
+          Logging.log("Unknown option: #{arg}")
           args_hash["option_#{i}"] = arg
         end
       else

data/lib/help.rb

@@ -2,27 +2,27 @@ require 'rubygems'
 
 class Help
   def self.display_help()
-    puts "Usage: aa [options] [input]"
-    puts "  -lf, --loadfile <path>: Load file into context"
-    puts "  -f, --file: Read from context file"
-    puts "  -c, --conversation: Append to conversation (max 10 Questions / Answers pairs saved)"
-    puts "  -d, --delete: Delete conversation"
-    puts "  -i, --interactive: Interactive mode, always a conversation. Clear context with 'clear' (exit with 'exit' or 'quit')"
-    puts "  -w, --whisper <path>: Transcribe audio file"
-    puts "  -t, --translate <path>: Translate audio file"
-    puts "\n  Options:"
-    puts "    --config: Edit config file"
-    puts "    -v, --version: Display version"
-    puts "    -h, --help: Display this help message"
+    Logging.log("Usage: aa [options] [input]")
+    Logging.log("  -lf, --loadfile <path>: Load file into context")
+    Logging.log("  -f, --file: Read from context file")
+    Logging.log("  -c, --conversation: Append to conversation (max 10 Questions / Answers pairs saved)")
+    Logging.log("  -d, --delete: Delete conversation")
+    Logging.log("  -i, --interactive: Interactive mode, always a conversation. Clear context with 'clear' (exit with 'exit' or 'quit')")
+    Logging.log("  -w, --whisper <path>: Transcribe audio file")
+    Logging.log("  -t, --translate <path>: Translate audio file")
+    Logging.log("\n  Options:")
+    Logging.log("    --config: Edit config file")
+    Logging.log("    -v, --version: Display version")
+    Logging.log("    -h, --help: Display this help message")
 
   end
  
   def self.display_api_key()
-    puts "You need to set your API key in the file: ./config/config.yml"
-    puts "Create the file if it doesn't exist."
-    puts "Add the following line to the file:"
-    puts "  OPENAI_API_KEY: <your API key>"
-    puts "You can get your API key from: https://openai.com/"
+    Logging.log("You need to set your API key in the file: ./config/config.yml")
+    Logging.log("Create the file if it doesn't exist.")
+    Logging.log("Add the following line to the file:")
+    Logging.log("  OPENAI_API_KEY: <your API key>")
+    Logging.log("You can get your API key from: https://openai.com/")
   end
 
   ## This don't work yet. Need to rework the way we handle args.
@@ -36,13 +36,13 @@ class Help
   end
 
   def self.display_version()
-    spec = Gem::Specification::load("aa.gemspec")
-    puts "Version: #{spec.version}"
+    spec = Gem::Specification::load("ask-ai.gemspec")
+    Logging.log("Version: #{spec.version}")
   end
 
   def self.display_usage()
-    puts "Usage: ./main.rb [options] [input]"
+    Logging.log("Usage: ./main.rb [options] [input]")
 
-    puts "There are two types of options, flags and arguments."
+    Logging.log("There are two types of options, flags and arguments.")
   end
 end

data/lib/logging.rb

@@ -0,0 +1,9 @@
+require 'logger'
+
+module Logging
+  def self.log(msg)
+    logger = Logger.new(STDOUT)
+    logger.formatter = proc { |_severity, _datetime, _progname, msg| "#{msg}\n" }
+    logger.info(msg)
+  end
+end

data/lib/main.rb

@@ -4,39 +4,33 @@ require 'fileutils'
 require 'yaml'
 require 'readline'
 require 'io/console'
-[
-  './prompt.rb',
-  './handle_args.rb',
-  './help.rb',
-  './context.rb'
-].each { |f| require_relative f }
+require './lib/logging.rb'
+require_relative './prompt.rb'
+require_relative './handle_args.rb'
+require_relative './help.rb'
+require_relative './context.rb'
+require_relative './files.rb'
 
-CONTEXT_PATH = File.expand_path("./../files/context.jsonl", __dir__)
-FILE_PATH = File.expand_path("./../files/", __dir__)
-CONFIG_PATH = File.expand_path("./../config/config.yml", __dir__)
-CONTEXT_FILE_PATH = File.expand_path("./../files/context_file.txt", __dir__)
 class Main
-
+  include Logging
+  include Files
   def self.run()
     config = load_env()
- 
+
     ## This does not work. Need to fix this.
-    if config.nil? || config['OPENAI_API_KEY'].nil?
-      puts "No API key found."
+    if config == false
+      Logging.log("No API key found.")
       Help.display_api_key()
-      puts 'If you want to set your API key now, type (y)es and press enter.'
-      #puts "If you have an API key you can set it here."
-      #puts "Enter API key: (or press enter to exit)"
-
+      Logging.log('If you want to set your API key now, type (y)es and press enter.')
       while input = Readline.readline("> ", true) do
         if input.empty?
-          puts "Exiting."
+          Logging.log("Exiting.")
           exit
         elsif input == "y" || input == "yes" || input == "Y" || input == "Yes"
           set_key()
           exit
         else
-          puts 'Invalid input (y)es or press enter to exit.'
+          Logging.log('Invalid input (y)es or press enter to exit.')
         end
       end
     end
@@ -80,7 +74,7 @@ class Main
           end
           Prompt.stream_prompt(input, file_as_string)
         when "-lf", "--loadfile"
-          puts "Loading File #{input}"
+          Logging.log("Loading File #{input}")
           Context.save_context_file(input)
         when "-d", "--delete"
           if input.nil?
@@ -90,39 +84,57 @@ class Main
             Context.save_context(Prompt.stream_prompt(input, context))
           end
         when "-c", "--conversation"
-          puts input
+          Logging.log(input)
           Context.save_context(Prompt.stream_prompt(input, context))
         when "-w", "--whisper"
-          puts Prompt.whisper_transcribe(input)
+          Logging.log(Prompt.whisper_transcribe(input))
         when "-t", "--translate"
-          puts Prompt.whisper_translate(input)
+          Logging.log(Prompt.whisper_translate(input))
         when "-i", "--interactive"
-          puts "Interactive mode..."
-          puts "Type 'exit' or 'quit' to exit."
-          puts "Type 'clear' to clear context."
+          Logging.log("Interactive mode...")
+          Logging.log("Type 'exit' or 'quit' to exit.")
+          Logging.log("Type 'clear' to clear context.")
+          Logging.log("Type 'show' to show context.")
+          Logging.log("Type 'help' to show help.")
+          Logging.log("Type 'config' to change config.")
+          Logging.log("Type '-w' to whisper transcribe.")
+          Logging.log("Type '-t' to whisper translate.")
 
           while input = Readline.readline("\n> ", true) do
-            if (input == "exit" || input == "quit")
-              break
+            case input
+              when "exit", "quit"
+                break
+              when "clear"
+                Logging.log("Clearing context...")
+                Context.delete_context()
+              when "help"
+                #TODO: This should be a specific help for interactive. 
+                Help.display_help()
+              when "show"
+                Logging.log("\n")
+                Logging.log(Context.load_context())
+              when /^-w/ 
+                stript_input = input.sub(/^-w/, "").strip
+                Logging.log(Prompt.whisper_transcribe(stript_input, interactive: true))
+              when /^-t/
+                stript_input = input.sub(/^-t/, "").strip
+                Logging.log(Prompt.whisper_translate(stript_input, interactive: true))
+              when "config"
+                set_key(api_key: nil)
+              else
+                #options_and_input = HandleArgs.handle_args()
+                context = Context.load_context()
+                Logging.log("")
+                Context.save_context(Prompt.stream_prompt(input, context))
+                Logging.log("")
             end
-            if input == "clear"
-              puts "Clearing context..."
-              Context.delete_context()
-              next
-            end
-            options_and_input = HandleArgs.handle_args()
-            context = Context.load_context()
-            puts "\n"
-            Context.save_context(Prompt.stream_prompt(input, context))
-            puts "\n"
           end
-          puts "Exiting..."
-          #Context.delete_context()
+          Logging.log("Exiting...")
         when "simple"
           if !input.nil?
             Prompt.stream_prompt(input)
           else
-            puts "No input given."
+            Logging.log("No input given.")
             Help.display_help()
           end
         else
@@ -136,33 +148,33 @@ class Main
 
   def self.set_key(api_key: nil)
     if api_key.nil?
-      puts "Setting API key..."
-      puts "Enter API key: (or press enter to exit)"
+      Logging.log("Setting API key...")
+      Logging.log("Enter API key: (or press enter to exit)")
 
       while input = Readline.readline("> ", true) do
         if input.empty?
-          puts "Exiting."
+          Logging.log("Exiting.")
           exit
         else
           api_key = input.strip
           break
         end
       end
-      puts "Saving API key..."
+      Logging.log("Saving API key...")
     end
 
-    FileUtils.mkdir_p(File.dirname(CONFIG_PATH))
-    File.open(CONFIG_PATH, "w") do |f|
+    FileUtils.mkdir_p(File.dirname(Files.config_path))
+    File.open(Files.config_path, "w") do |f|
       f.write(YAML.dump({ "OPENAI_API_KEY" => api_key }))
     end
-    puts "API key saved."
+    Logging.log("API key saved.")
   end
 
   def self.load_env()
-    YAML.load(File.read(CONFIG_PATH))
+    YAML.load(File.read(Files.config_path))
 
   rescue Errno::ENOENT
-    puts "No config.yml found."
+    Logging.log("No config.yml found.")
   end
 end
 

data/lib/paths.rb

@@ -0,0 +1,26 @@
+
+module Files
+  def self.root
+    File.expand_path("./../", __dir__)
+  end
+
+  def self.context
+    File.expand_path("./../files/context.jsonl", __dir__)
+  end
+
+  def self.files
+    FILE_PATH
+  end
+
+  def self.config
+    CONFIG_PATH
+  end
+
+  def self.context_file
+    CONTEXT_FILE_PATH
+  end
+end
+CONTEXT_PATH = File.expand_path("./../files/context.jsonl", __dir__)
+FILE_PATH = File.expand_path("./../files/", __dir__)
+CONFIG_PATH = File.expand_path("./../config/config.yml", __dir__)
+CONTEXT_FILE_PATH = File.expand_path("./../files/context_file.txt", __dir__)

data/lib/prompt.rb

@@ -1,7 +1,8 @@
 require "openai"
+require_relative './files.rb'
 
 class Prompt
-
+  include Files
   ## Streams the response, VERY NICE
   def self.stream_prompt(input, conversation = '', temp = 0.7)
     if conversation.length == 0
@@ -9,7 +10,6 @@ class Prompt
     else
       conversation += "\n My question: #{input}"
     end
-
     response = ''
     client.chat(
       parameters: {
@@ -26,6 +26,7 @@ class Prompt
       "input" => input,
       "response" => response,
     }
+
     return context
   end
 
@@ -39,15 +40,19 @@ class Prompt
     client.files.delete(id: "file-123")
   end
 
-  def self.whisper_translate(file_path)
+  def self.whisper_translate(file_path, interactive = false)
     if (file_path.nil? || !file_path.end_with?(*['.mp3', '.wav', '.m4a', '.webm', '.mpeg', '.mpga']))
-      puts "No file given or wrong file type"
-      exit
+      Logging.log("No file given or wrong file type")
+      unless interactive
+        exit
+      end
     else
       size = File.size(file_path).to_f / 2**20
       if size > 24
         warning("The file is above the maximum size of 25MB")
-        exit
+        unless interactive
+          exit
+        end
       else
         response = client.audio.translate(
         parameters: {
@@ -55,25 +60,31 @@ class Prompt
             file: File.open(file_path, "rb"),
         })
         if (response["text"].nil? || response["text"].empty?)
-          puts "No text found"
-          exit
+          Logging.log("No text found")
+          unless interactive
+            exit
+          end
         end
-        puts response["text"]
+        return response["text"]
       end
     end
   rescue Errno::ENOENT => e
-    puts "File not found"
+    Logging.log(e)
   end
 
-  def self.whisper_transcribe(file_path)
+  def self.whisper_transcribe(file_path, interactive = false)
     if (file_path.nil? || !file_path.end_with?(*['.mp3', '.wav', '.m4a', '.webm', '.mpeg', '.mpga']))
-      puts "No file given"
-      exit
+      Logging.log("No file given")
+      unless interactive
+        exit
+      end
     else
       size = File.size(file_path).to_f / 2**20
       if size > 24
-        warning("The file is above the maximum size of 25MB, this may take")
-        exit
+        warning("The file is above the maximum size of 25MB")
+        unless interactive
+          exit
+        end
       else
         response = client.audio.transcribe(
         parameters: {
@@ -81,20 +92,23 @@ class Prompt
             file: File.open(file_path, "rb"),
         })
         if (response["text"].nil? || response["text"].empty?)
-          puts "No text found"
-          exit
+          Logging.log("No text found")
+          unless interactive
+            exit
+          end
         end
-        puts response["text"]
+        return response["text"]
       end
     end
   rescue Errno::ENOENT => e
-    puts "File not found"
+    #Logging.log("File not found")
+    Logging.log(e)
   end
 
   private
 
   def self.client()
-    conf = YAML.load(File.read(CONFIG_PATH))
+    conf = YAML.load(File.read(Files.config_path))
     key = conf["OPENAI_API_KEY"]
 
     OpenAI::Client.new(access_token: key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ask-ai
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Oskar Franck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-22 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -28,21 +28,25 @@ description: A CLI tool for using OpenAI's API. The idea is to make it easy to u
   the API with an option to pass files for help with diffrent tasks.
 email: contact.oskarfranck.se
 executables:
-- aa
+- ask-ai
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/aa
+- bin/ask-ai
 - config/config.yml
 - files/context.jsonl
 - files/context_file.txt
 - lib/context.rb
+- lib/files.rb
 - lib/handle_args.rb
 - lib/help.rb
+- lib/logging.rb
 - lib/main.rb
+- lib/paths.rb
 - lib/prompt.rb
-homepage: 
-licenses: []
+homepage: https://github.com/OskarFranck/terminal_chat
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -59,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A simple CLI for OpenAI's GPT-3 API.