aiagent 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ca59dbb48716e29658c4e73e94e75c2c017f4b1f7bfb5b3a1a7865c4411ebf1
-  data.tar.gz: aa1d848208b8a9205cab096d382fb5ca40ad051507d4a09e0ec5f52160c2474b
+  metadata.gz: '02942755b5e166577ba8df4d4ec900b09aa0d4b18bffad704ac13c46c2d46dec'
+  data.tar.gz: 60ffc49db83174ad4df31da6b94b9a71d732deb594300c1bfd7447d75db16649
 SHA512:
-  metadata.gz: 42ca5e9c3e0234e6671afcf986d5525b1cb8fb9fd5fb00652e66e7072d424007c09b22c302065040ea1abc9b2c57c7e90acffa128c51adc7d7a2fa738259e6ff
-  data.tar.gz: e4789e27b79fe54fcafc800e47326a192dafcf57e3411fbdf4cf66a92834947d77b59e676ed83cdfd2e439067d471c6e97503763f3fb8f3572edd2ac34e47af9
+  metadata.gz: 47c92de7b86be56966a0a02b427f1daa3e2044453af2061de9ba7a0fa09d9d6451b6c28fd6fd37bcc92b8910292afeebb64f7e4088ee22c9854aa58b0653f471
+  data.tar.gz: d8254076ca058ec7b07c512838a4e3ec030051ff05cfda098d3afa0681a29403383a83998d3e5ec06e8ebc243bbe0ae97c90528ba84b5bc3704da7a2090f34a3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.3.0] - 2024-07-09
+
+- Added OpenAI support
+
 ## [0.2.0] - 2024-07-09
 
 - Allow API key to be set when instantiating the agent

data/Gemfile.lock

@@ -1,22 +1,16 @@
 PATH
   remote: .
   specs:
-    aiagent (0.1.0)
-      httparty
+    aiagent (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     docile (1.4.0)
-    httparty (0.21.0)
-      mini_mime (>= 1.0.0)
-      multi_xml (>= 0.5.2)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
-    mini_mime (1.1.5)
     minitest (5.22.2)
-    multi_xml (0.6.0)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
@@ -51,10 +45,10 @@ GEM
 PLATFORMS
   arm64-darwin-22
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   aiagent!
-  httparty
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)

data/README.md

@@ -53,17 +53,53 @@ ai_agent = AiAgent::Claude.new(api_key: 'ANTHROPIC_API_KEY')
 
 ## Usage
 
-Basic example usage for Claude:
+Basic example usage for OpenAI ChatGPT:
+
+```ruby
+ai_agent = AiAgent::OpenAI.new(timeout: 30)
+prompt = "Generate 5 inspirational quotes."
+messages = [{ 'role': 'user', 'content': prompt }]
+response = ai_agent.chat(messages, options: {})
+ai_agent.format_response(response)
+```
+
+Basic example usage for Anthropic Claude:
+
+```ruby
+ai_agent = AiAgent::Claude.new(timeout: 30)
+prompt = "Generate 5 inspirational quotes."
+messages = [{ 'role': 'user', 'content': prompt }]
+response = ai_agent.chat(messages, options: {})
+ai_agent.format_response(response)
+```
+
+
+At the API level Claude 'system' message needs to be a parameter in the options rather than an element in the messages array.
+
+Using AiAgent you have the choice of using a Claude-specific 'send_messages' method which takes the data in the format expected by Claude, or you can use  the more standard 'chat' interface, which follows the openai convention and will be mapped seamlessly by AiAgent.
+
+Example using send_messages:
 
 ```ruby
 ai_agent = AiAgent::Claude.new(timeout: 30)
 prompt = "Generate 5 inspirational quotes."
 messages = [{ 'role': 'user', 'content': prompt }]
-options = {}
-response = ai_agent.send_messages(messages, options)
+response = ai_agent.send_messages(messages, options: { system: 'Reply only in Spanish.' })
 ai_agent.format_response(response)
 ```
 
+Example using chat:
+
+```ruby
+ai_agent = AiAgent::Claude.new(timeout: 30)
+prompt = "Generate 5 inspirational quotes."
+messages = [{ 'role': 'system', 'content': 'Reply only in Spanish' }, { 'role': 'user', 'content': prompt }]
+response = ai_agent.chat(messages, options: {})
+ai_agent.format_response(response)
+```
+
+## Prepared prompts
+
 Sentiment analysis:
 ```ruby
 ai_agent = AiAgent::Claude.new

data/lib/ai_agent/ai_agent/claude.rb

@@ -20,7 +20,23 @@ module AiAgent
       claude if agent == CLAUDE
     end
 
-    def send_messages(messages, options)
+    # When using the 'chat' interface we need to do a bit of rejigging because
+    # Claude expects the system message to be in options instead of messages.
+    def chat(messages, options: {})
+      system_content = nil
+      messages.reject! do |hash|
+        if hash[:role] == 'system'
+          system_content = hash[:content]
+          true
+        else
+          false
+        end
+      end
+
+      send_messages(messages, options: options.reverse_merge(system: system_content))
+    end
+
+    def send_messages(messages, options: {})
       client.messages(messages, options)
     end
 

data/lib/ai_agent/ai_agent/open_ai.rb

@@ -0,0 +1,45 @@
+require "ai_agent/base"
+if Gem.loaded_specs.has_key?('ruby-openai')
+  # require 'ruby-openai'
+else
+  Rails.logger.warn "ruby-openai gem is not loaded"
+end
+
+module AiAgent
+  OPENAI = 'openai'.freeze
+
+  class OpenAI < Base
+    module Model
+      GPT_4O = 'gpt-4o'
+      GPT_4_TURBO = 'gpt-4-turbo'
+      GPT_4 = 'gpt-4'
+      GPT_3_5_TURBO= 'gpt-3.5-turbo'
+    end
+
+    def initialize(api_key: nil, endpoint: nil, timeout: 60)
+      self.agent = OPENAI
+      self.api_key = api_key || ENV['OPENAI_API_KEY']
+      self.endpoint = endpoint # nil for default as defined in openai/client
+      self.timeout = timeout
+    end
+
+    def client
+      openai if agent == OPENAI
+    end
+
+    def chat(messages, options: {})
+      params = options.reverse_merge(model: Model::GPT_4O, temperature: 0.1)
+      client.chat(parameters: params.merge(messages: messages))
+    end
+
+    def format_response(response)
+      response['choices'][0]['message']['content'] rescue "ERROR: Couldn't extract text from OpenAI response"
+    end
+
+    private
+
+    def openai
+      @openai ||= ::OpenAI::Client.new(access_token: api_key, uri_base: endpoint, request_timeout: timeout)
+    end
+  end
+end

data/lib/ai_agent/base.rb

@@ -16,8 +16,11 @@ module AiAgent
       raise NotImplementedError, "Subclasses must implement the client method"
     end
 
-    def send_messages(messages, options)
-      raise NotImplementedError, "Subclasses must implement the send_message method"
+    # messages should be an array of hashes, where each hash contains role and content.
+    # role can be 'system', 'assistant', or 'user'.
+    # e.g. [{ 'role': 'system', 'content': 'You are a helpful assistant' }, { 'role': 'user', 'content': 'Tell me a joke' }]
+    def chat(messages, options: {})
+      raise NotImplementedError, "Subclasses must implement the chat (completions) method"
     end
 
     def format_response(response)
@@ -26,41 +29,47 @@ module AiAgent
 
     def analyze_sentiment(text, strict: true, options: {})
       prompt = "Analyze the sentiment of the following text and classify it as positive, negative, or neutral:\n\n#{text}\n\nSentiment: "
+      messages = [{ 'role': 'user', 'content': prompt }]
+      system = options.delete(:system)
       if strict
-        system = "If you are asked to return a word, then return only that word with no preamble or postamble. " if strict
+        system = ["If you are asked to return a word, then return only that word with no preamble or postamble.", system].compact.join(' ')
+        messages.prepend({ 'role': 'system', 'content': system })
         max_tokens = 2
       else
         max_tokens = 100
       end
 
-      send_messages([ { 'role': 'user', 'content': prompt } ],
-                    options.reverse_merge( system: system, max_tokens: max_tokens ))
+      chat(messages, options: options.reverse_merge( max_tokens: max_tokens ))
     end
 
     def recognize_entities(text, strict: true, options: {})
       prompt = "Identify and list the named entities in the following text:\n\n#{text}\n\nEntities: "
+      messages = [{ 'role': 'user', 'content': prompt }]
+      system = options.delete(:system)
       if strict
-        system = "Be specific in your answer, with no preamble or postamble. If you are asked to list some names, then return only a list of those names, nothing else. "
+        system = ["Be specific in your answer, with no preamble or postamble. If you are asked to list some names, then return only a list of those names, nothing else. ", system].compact.join(' ')
+        messages.prepend({ 'role': 'system', 'content': system })
         max_tokens = 100
       else
         max_tokens = 500
       end
 
-      send_messages([ { 'role': 'user', 'content': prompt } ],
-                    options.reverse_merge( system: system, max_tokens: max_tokens ))
+      chat(messages, options: options.reverse_merge( max_tokens: max_tokens ))
     end
 
     def summarize_text(text, strict: true, options: {})
       prompt = "Summarize the following text:\n\n#{text}\n\nSummary: "
+      messages = [{ 'role': 'user', 'content': prompt }]
+      system = options.delete(:system)
       if strict
-        system = "Be specific in your answer, with no preamble or postamble. I.e. return only what the user asks for, nothing else. "
+        system = ["Be specific in your answer, with no preamble or postamble. I.e. return only what the user asks for, nothing else. ", system].compact.join(' ')
+        messages.prepend({ 'role': 'system', 'content': system })
         max_tokens = 100
       else
         max_tokens = 500
       end
 
-      send_messages([ { 'role': 'user', 'content': prompt } ],
-                    options.reverse_merge( system: system, max_tokens: max_tokens ))
+      chat(messages, options: options.reverse_merge( max_tokens: max_tokens ))
     end
   end
 end

data/lib/ai_agent/ruby/version.rb

@@ -2,6 +2,6 @@
 
 module AiAgent
   module Ruby
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aiagent
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Web Ventures Ltd
@@ -25,6 +25,7 @@ files:
 - README.md
 - Rakefile
 - lib/ai_agent/ai_agent/claude.rb
+- lib/ai_agent/ai_agent/open_ai.rb
 - lib/ai_agent/base.rb
 - lib/ai_agent/ruby.rb
 - lib/ai_agent/ruby/version.rb