Add basic personas support

codergeek121 · codergeek121 · commit f9d33802cb30 · 2023-07-24T22:05:26.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,15 +3,14 @@
 The following topics are missing for a 1.0.0 release:
 
 ```
-* Allow adding "personas" to the config ([see here](docs/personas.md))
-* Rewrite with tests as soon as the basic prototype is useful
+* Rewrite/Refactor with tests as soon as the basic prototype is useful
 * Add GitHub Actions for PRs
 * Build a landing page
 ```
 
 Please use `clai` and contribute here on GitHub. I'm open to all suggestions and improvements.
 
-0.x.x versions don't need tests or extensive documentation. Adding a small description will help me understand your change though :)
+PRs for the 0.x.x versions don't need tests or extensive documentation. Adding a small description will help me understand your change though :)
 
 Please open a PR with a short description of your use-case and I will review and merge.
 
diff --git a/docs/chat.md b/docs/chat.md
@@ -4,7 +4,9 @@ Send a single prompt to the completions api.
 
 Some examples:
 
-
 ```
 clai chat "Tell me a funny joke"
+
+# Write ruby code
+clai chat "Count to 10" --persona ruby
 ```
diff --git a/docs/intro.md b/docs/intro.md
@@ -1,10 +1,10 @@
 # Introduction
 
 You can think of `clai` as ChatGPT for the terminal.
-It's very basic at the moment. You can think of it as ChatGPT for the terminal. I'm currently trying to incorporate clai in my daily work, so I'm still experimenting with the API.
+It's very basic at the moment. I'm currently trying to incorporate clai in my daily work, so I'm still experimenting with the API.
 
 `clai` currently supports OpenAI and needs a paid API key to work.
 
 My main use case currently is to have a terminal opened with a clai session and ask questions instead of googling.
 
-0.x.0 will be unstable and untested, I'm currently aiming to release a tested 1.0.0 soon. Please see [here](https://github.com/codergeek121/clai/CONTRIBUTING.MD) on how to contribute at this stage of the project.
+0.x.0 will be unstable and untested, I'm currently aiming to release a tested 1.0.0 soon. Please see [here](https://github.com/codergeek121/clai/CONTRIBUTING.MD) on how to contribute at the current stage of the project.
diff --git a/docs/personas.md b/docs/personas.md
@@ -1,23 +1,36 @@
 # Personas
 
-TODO: This feature is still under development!
+Clai allows you to configure different personas. Whenever you're calling clai, it's possible to pass a specified persona with `--persona`. This will pass system prompts to ChatGPT. It works similar to "Custom instructions" in ChatGPT.
 
-A clai setup should allow preconfiguring multiple personas. Each command should support a `--persona` option to allow setting some default prompts to the api.
-
-An example could look like this:
+The base clai setup comes with the following default personas config:
 
 ```yaml
 personas:
-  work:
-    - Use professional language
-    - Keep your answer below 100 words
-  bavarian:
-    - Use a bavarian accent
-
-# Starting a session with a preselected persona
-$ clai session --persona bavarian
-Your prompt: <Your prompt><Enter>
-Some bavarian answer.
+  default:
+    - You are a helpful assistant
+    - You answers are formatted in markdown
+  ruby:
+    - You are a ruby programmer
+    - You do not comment your code
+```
+
+Compare the outputs when using different personas.
+
+```
+$ clai chat "Count to 10" --persona ruby
+Sure, here's how you can count to 10 in Ruby:
+
+(1..10).each do |num|
+  puts num
+end
+
+// Without a persona, fallbacks to the "default" persona
+$ clai chat "Count to 10"
+
+1, 2, 3, 4, 5, 6, 7, 8, 9, 10
+
+// Start a ruby persona session
+$ clai session --persona ruby
 ```
 
-The default setup should have useful personas as a default.
+The persona under the key `default:` is used whenever you're not specifying a explicit persona.
diff --git a/docs/session.md b/docs/session.md
@@ -1,3 +1,12 @@
 # Session
 
-TODO
+Start a REPL like chat session.
+
+Some examples:
+
+```
+clai session
+
+# Start a Ruby session
+clai session --persona ruby
+```
diff --git a/docs/setup.md b/docs/setup.md
@@ -1,3 +1,5 @@
 # Setup
 
-TODO
+`clai setup` will create a config file with a base configuration.
+
+`clai setup --force` will overwrite the basic config with the default configuration. It's mainly useful in development of the gem.
diff --git a/lib/clai/cli.rb b/lib/clai/cli.rb
@@ -2,24 +2,34 @@ module CLAI
   class CLI < Thor
     default_task :session
 
+    option :persona, type: :string
     desc "session", "Start an interactive chat session"
     long_desc <<~DESC
     Starts a REPL like chat process
 
     > $ clai session
+
+    Use a preconfigured persona with --persona
+
+    > $ clai chat "Count to 10" --persona ruby
     DESC
     def session
-      Commands::Session.new(config).start_session
+      Commands::Session.new(config).start_session(persona: options['persona'])
     end
 
+    option :persona, type: :string
     desc "chat", "Prompt on the terminal"
     long_desc <<~DESC
     Send a single prompt to AI
 
     > $ clai chat "Tell me a short story!"
+
+    Use a preconfigured persona with --persona
+
+    > $ clai chat "Count to 10" --persona ruby
     DESC
     def chat(prompt)
-      Commands::Chat.new(config).chat(prompt)
+      Commands::Chat.new(config).chat(prompt, persona: options['persona'])
     end
 
     option :force, type: :boolean, default: false
diff --git a/lib/clai/commands/chat.rb b/lib/clai/commands/chat.rb
@@ -5,8 +5,9 @@ def initialize(config)
         @config = config
       end
 
-      def chat(prompt)
-        HTTPClient.new(@config).chat(prompt)
+      def chat(prompt, persona: 'default')
+        system_prompts = @config.personas.fetch(persona, [])
+        HTTPClient.new(@config).chat(prompt, system_prompts: system_prompts)
       end
     end
   end
diff --git a/lib/clai/commands/session.rb b/lib/clai/commands/session.rb
@@ -5,12 +5,13 @@ def initialize(config)
         @config = config
       end
 
-      def start_session
+      def start_session(persona: 'default')
+        system_prompts = @config.personas.fetch(persona, [])
         loop do
           print S.(:prompt)
           question = $stdin.gets
           break unless question
-          HTTPClient.new(@config).chat(question.strip)
+          HTTPClient.new(@config).chat(question.strip, system_prompts: system_prompts)
           puts
         end
       end
diff --git a/lib/clai/commands/setup.rb b/lib/clai/commands/setup.rb
@@ -42,6 +42,13 @@ def sample_config
           # Read more about the clai.yml config file at https://github.com/codergeek121/clai/docs/setup.md
           api_key: #{@api_key}
           model: gpt-3.5-turbo
+          personas:
+            default:
+              - You are a helpful assistant
+              - You answers are formatted in markdown
+            ruby:
+              - You are a ruby programmer
+              - You do not comment your code
         YML
       end
     end
diff --git a/lib/clai/config.rb b/lib/clai/config.rb
@@ -2,17 +2,22 @@ module CLAI
   class Config
     def self.parse
       config = YAML.safe_load_file(CLAI.config_file_path)
-      new(api_key: config["api_key"], model: config["model"])
+      new(
+        api_key: config["api_key"],
+        model: config["model"],
+        personas: config["personas"]
+      )
     rescue Errno::ENOENT
       puts S.(:no_clai_yml)
       exit(false)
     end
 
-    attr_reader :api_key, :model
+    attr_reader :api_key, :model, :personas
 
-    def initialize(api_key:, model:)
+    def initialize(api_key:, model:, personas:)
       @api_key = api_key
       @model = model
+      @personas = personas
     end
   end
 end
diff --git a/lib/clai/http_client.rb b/lib/clai/http_client.rb
@@ -4,14 +4,16 @@ def initialize(config)
       @config = config
     end
   
-    def chat(query)
+    def chat(query, system_prompts: [])
+      system_prompts = system_prompts.map { |prompt| { role: :system, content: prompt } }
       puts
       client
         .post("https://api.openai.com/v1/chat/completions",
           json: {
             model: @config.model,
             messages: [
-              { "role": "user", "content": query }
+              *system_prompts,
+              { "role": "user", "content": query },
             ],
             stream: true
           }

-Original file line number
+Diff line change
@@ @@ -1,3 +1,5 @@ @@
 # Setup
 -TODO
 +`clai setup` will create a config file with a base configuration.
++
 +`clai setup --force` will overwrite the basic config with the default configuration. It's mainly useful in development of the gem.