ask-ai 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f66251ade1f9986ae077dc13cb177f5f651b5c3638115fb7b5a5ef54d9510972
+  data.tar.gz: ec6673e17d5cdd7e6e202ad33d87f30b4e132afdbde347c67917aee6a7483291
+SHA512:
+  metadata.gz: c4c71fbb474ebbea5684fc849007f04af964c105ae9a8827790da443a4c45168b59ba5c49b90644bdd8d3f46ca03d5ad31535bf244eace5b00d017f43aae36e1
+  data.tar.gz: 69dea278d20a873ba3a91f93dd41e97d148e754cf654ac32c6ca3ad168bc57a66bd3816db23aa38362bf81a18be3453d08e2201d1ec134ed1230b5a792f70000

data/bin/aa

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/main.rb'
+
+Main::run

data/config/config.yml

@@ -0,0 +1 @@
+

data/lib/context.rb

@@ -0,0 +1,79 @@
+class Context
+  def self.load_context()
+    if File.exist?(CONTEXT_PATH)
+      conversation = File.readlines(CONTEXT_PATH).map { |line| JSON.parse(line) }
+    else
+      conversation = []
+    end
+
+    if conversation.length > 0
+      context_as_string = "This is our previous conversation:\n"
+    else
+      context_as_string = ""
+    end
+
+    if conversation.length > 0
+      conversation.each_with_index do |v, i|
+        context_as_string += "My #{i + 1} input was: #{v['input']}\nYour #{i + 1} response was: #{v['response']}\n"
+      end
+    end
+
+    return context_as_string
+  end
+
+  ## Here we save the context to a file.
+  ## 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") {}
+    end
+    File.readlines(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") }
+  end
+
+  def self.delete_context()
+    puts "Deleting previous context."
+    File.truncate(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')
+      char_count = 0
+      file_in.each do |line|
+        char_count += line.length
+        file_out.write(line)
+      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."
+      end
+    else
+      puts "No file path given."
+    end
+  rescue Errno::ENOENT
+    puts "No file at '#{file_path}' found."
+  end
+
+  def self.load_context_file()
+    file = File.open(CONTEXT_FILE_PATH, 'r')
+    file_as_string = ""
+    file.each do |line|
+      file_as_string += line
+    end
+
+    return file_as_string
+  rescue Errno::ENOENT
+    puts "No file at '#{CONTEXT_FILE_PATH}' found."
+    puts "Load a file with 'aa -lf <file_path>'"
+    return ""
+  end
+
+end

data/lib/handle_args.rb

@@ -0,0 +1,61 @@
+class HandleArgs 
+  def self.permitted_options()
+    ## TODO: Add more options.
+    ## -t --translate
+    ## -temp --temperature (need to handle value after input)
+
+    [
+      '-h',
+      '--help',
+      '-v',
+      '--version',
+      '-f',
+      '--file',
+      '-lf',
+      '--loadfile',
+      '-d',
+      '--delete',
+      '-c',
+      '--conversation',
+      '--finetune',
+      '-w', '--whisper',
+      '-t', '--translate',
+      '-i', '--interactive',
+      '--key',
+  ]
+end
+
+  def self.handle_args()
+    p_args = HandleArgs.permitted_options()
+    ## This is the hash that will be returned.
+    args_hash = {}
+
+    ## This handles args then called as ruby script.
+    ARGV.each_with_index do |arg, i|
+      #puts "Arg: #{arg}"
+
+      if arg.start_with?('-')
+        ## This is an option.
+        if p_args.include?(arg)
+          ## This is a permitted / available option.
+          #puts "Option: #{arg}"
+          args_hash["option_#{i}"] = arg
+        else
+          ## This is an unknown option.
+          ## TODO: Handle unknown option. display help? discard?
+          puts "Unknown option: #{arg}"
+          args_hash["option_#{i}"] = arg
+        end
+      else
+        ## This is input.
+        ## This if statement append all 'input' args to one string.
+        if args_hash["input"].nil?
+          args_hash["input"] = arg
+        else
+          args_hash["input"] = "#{args_hash['input']} #{arg}"
+        end
+      end
+    end
+    return args_hash
+  end
+end

data/lib/help.rb

@@ -0,0 +1,48 @@
+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"
+
+  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/"
+  end
+
+  ## This don't work yet. Need to rework the way we handle args.
+  def self.display_help_file()
+    ## TODO: How to work with files
+  end
+
+  ## This don't work yet. Need to rework the way we handle args.
+  def self.display_help_conversation()
+    ## TODO: How to work with conversation
+  end
+
+  def self.display_version()
+    spec = Gem::Specification::load("aa.gemspec")
+    puts "Version: #{spec.version}"
+  end
+
+  def self.display_usage()
+    puts "Usage: ./main.rb [options] [input]"
+
+    puts "There are two types of options, flags and arguments."
+  end
+end

data/lib/main.rb

@@ -0,0 +1,168 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'yaml'
+require 'readline'
+require 'io/console'
+[
+  './prompt.rb',
+  './handle_args.rb',
+  './help.rb',
+  './context.rb'
+].each { |f| require_relative f }
+
+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
+
+  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."
+      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)"
+
+      while input = Readline.readline("> ", true) do
+        if input.empty?
+          puts "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.'
+        end
+      end
+    end
+
+    context = Context.load_context()
+    options_and_input = HandleArgs.handle_args()
+    options = options_and_input.select { |k, v| k.start_with?("option_") }
+    input = options_and_input["input"]
+
+    halt_options = ["-h", "--help", "-v", "--version", "--key"]
+
+    ## Hack... Need to fix this.
+    if options.empty?
+      options = { "option_0" => "simple" }
+    end
+
+    options.each do |k, v|
+      if halt_options.include?(v)
+        ## Options that halt the program.
+        case v
+        when "-h", "--help"
+          Help.display_help()
+          exit
+        when "-v", "--version"
+          Help.display_version()
+          exit
+        
+        when "--key"
+          set_key(api_key: nil)
+        else
+          Help.display_help()
+          exit
+        end
+      else
+        ## Options that don't halt the program.
+        case v
+        when "-f", "--file"
+          file_as_string = Context.load_context_file()
+          if file_as_string.empty?
+            exit
+          end
+          Prompt.stream_prompt(input, file_as_string)
+        when "-lf", "--loadfile"
+          puts "Loading File #{input}"
+          Context.save_context_file(input)
+        when "-d", "--delete"
+          if input.nil?
+            Context.delete_context()
+          else
+            Context.delete_context()
+            Context.save_context(Prompt.stream_prompt(input, context))
+          end
+        when "-c", "--conversation"
+          puts input
+          Context.save_context(Prompt.stream_prompt(input, context))
+        when "-w", "--whisper"
+          puts Prompt.whisper_transcribe(input)
+        when "-t", "--translate"
+          puts Prompt.whisper_translate(input)
+        when "-i", "--interactive"
+          puts "Interactive mode..."
+          puts "Type 'exit' or 'quit' to exit."
+          puts "Type 'clear' to clear context."
+
+          while input = Readline.readline("\n> ", true) do
+            if (input == "exit" || input == "quit")
+              break
+            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()
+        when "simple"
+          if !input.nil?
+            Prompt.stream_prompt(input)
+          else
+            puts "No input given."
+            Help.display_help()
+          end
+        else
+          Help.display_help()
+        end
+      end
+    end
+  end
+
+  private
+
+  def self.set_key(api_key: nil)
+    if api_key.nil?
+      puts "Setting API key..."
+      puts "Enter API key: (or press enter to exit)"
+
+      while input = Readline.readline("> ", true) do
+        if input.empty?
+          puts "Exiting."
+          exit
+        else
+          api_key = input.strip
+          break
+        end
+      end
+      puts "Saving API key..."
+    end
+
+    FileUtils.mkdir_p(File.dirname(CONFIG_PATH))
+    File.open(CONFIG_PATH, "w") do |f|
+      f.write(YAML.dump({ "OPENAI_API_KEY" => api_key }))
+    end
+    puts "API key saved."
+  end
+
+  def self.load_env()
+    YAML.load(File.read(CONFIG_PATH))
+
+  rescue Errno::ENOENT
+    puts "No config.yml found."
+  end
+end
+

data/lib/prompt.rb

@@ -0,0 +1,102 @@
+require "openai"
+
+class Prompt
+
+  ## Streams the response, VERY NICE
+  def self.stream_prompt(input, conversation = '', temp = 0.7)
+    if conversation.length == 0
+      conversation += input
+    else
+      conversation += "\n My question: #{input}"
+    end
+
+    response = ''
+    client.chat(
+      parameters: {
+        model: "gpt-3.5-turbo",
+        messages: [{ role: "user", content: conversation}],
+        temperature: temp, ## Should be a parameter
+        stream: proc do |chunk, _bytesize|
+          response += chunk.dig("choices", 0, "delta", "content") unless chunk.dig("choices", 0, "delta", "content").nil?
+          print chunk.dig("choices", 0, "delta", "content")
+        end
+      }
+    )
+    context = {
+      "input" => input,
+      "response" => response,
+    }
+    return context
+  end
+
+  ## Not implemented only scaffolding
+  def self.file_finetune()
+    return
+    client.files.upload(parameters: { file: "./test.json", purpose: "fine-tune" })
+    client.files.lisr
+    client.files.retrieve(id: "file-123")
+    client.files.content(id: "file-123")
+    client.files.delete(id: "file-123")
+  end
+
+  def self.whisper_translate(file_path)
+    if (file_path.nil? || !file_path.end_with?(*['.mp3', '.wav', '.m4a', '.webm', '.mpeg', '.mpga']))
+      puts "No file given or wrong file type"
+      exit
+    else
+      size = File.size(file_path).to_f / 2**20
+      if size > 24
+        warning("The file is above the maximum size of 25MB")
+        exit
+      else
+        response = client.audio.translate(
+        parameters: {
+            model: "whisper-1",
+            file: File.open(file_path, "rb"),
+        })
+        if (response["text"].nil? || response["text"].empty?)
+          puts "No text found"
+          exit
+        end
+        puts response["text"]
+      end
+    end
+  rescue Errno::ENOENT => e
+    puts "File not found"
+  end
+
+  def self.whisper_transcribe(file_path)
+    if (file_path.nil? || !file_path.end_with?(*['.mp3', '.wav', '.m4a', '.webm', '.mpeg', '.mpga']))
+      puts "No file given"
+      exit
+    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
+      else
+        response = client.audio.transcribe(
+        parameters: {
+            model: "whisper-1",
+            file: File.open(file_path, "rb"),
+        })
+        if (response["text"].nil? || response["text"].empty?)
+          puts "No text found"
+          exit
+        end
+        puts response["text"]
+      end
+    end
+  rescue Errno::ENOENT => e
+    puts "File not found"
+  end
+
+  private
+
+  def self.client()
+    conf = YAML.load(File.read(CONFIG_PATH))
+    key = conf["OPENAI_API_KEY"]
+
+    OpenAI::Client.new(access_token: key)
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: ask-ai
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oskar Franck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+description: A CLI tool for using OpenAI's API. The idea is to make it easy to use
+  the API with an option to pass files for help with diffrent tasks.
+email: contact.oskarfranck.se
+executables:
+- aa
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/aa
+- config/config.yml
+- files/context.jsonl
+- files/context_file.txt
+- lib/context.rb
+- lib/handle_args.rb
+- lib/help.rb
+- lib/main.rb
+- lib/prompt.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: A simple CLI for OpenAI's GPT-3 API.
+test_files: []