aiagent 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f54f71f8b08b031f351313bcf6fd253fdd2a588ef7d17da74115ff2b72561bb0
-  data.tar.gz: 2a8004689fc829d08872840029e8729be303aaf236f33500e8f979d8b8c4e92d
+  metadata.gz: '02942755b5e166577ba8df4d4ec900b09aa0d4b18bffad704ac13c46c2d46dec'
+  data.tar.gz: 60ffc49db83174ad4df31da6b94b9a71d732deb594300c1bfd7447d75db16649
 SHA512:
-  metadata.gz: bf0f1f4447b4608769fdffe194bf210cd9f409bcf00c387c0e370466b2ca3188e3e3880075ac14267f62597ed62b2389632e7943e410004d80cedf82a0cab3f0
-  data.tar.gz: 44a6f23bfe09e4ce4e3a32ccbf8eecaa935d7b4b63aa59ffd98bb237a574731804036c51a79b42b14fd8a9113a23e4c8ad0b91484f1f938277eeb1f235049c68
+  metadata.gz: 47c92de7b86be56966a0a02b427f1daa3e2044453af2061de9ba7a0fa09d9d6451b6c28fd6fd37bcc92b8910292afeebb64f7e4088ee22c9854aa58b0653f471
+  data.tar.gz: d8254076ca058ec7b07c512838a4e3ec030051ff05cfda098d3afa0681a29403383a83998d3e5ec06e8ebc243bbe0ae97c90528ba84b5bc3704da7a2090f34a3

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [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
+- Allow timeout to be set
+- Allow endpoint to be customised
+- Improved documentation
+
 ## [0.1.0] - 2024-07-09
 
 - Initial release

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

@@ -2,8 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/aiagent.svg)](https://badge.fury.io/rb/aiagent) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-** Example usage coming soon in the next version of this gem **
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,14 +27,102 @@ $ gem install aiagent
 Create an initializer called config/initializers/ai_agent.rb \
 And in that file simply require the agents that you'll use in your project.
 
-E.g. \
+Example initializer:
+```ruby
+# config/initializers/ai_agent.rb
+
 require "ai_agent/ai_agent/claude"
+```
+## Setup
+
+To use this gem you'll need an API key for the agents that you want to use.
+
+Set your API keys as environment variables, or pass them to the AiAgent initialize method.
+
+Example with environment variables:
+```ruby
+# ENV['ANTHROPIC_API_KEY'] = 'YOUR_ANTHROPIC_API_KEY'
+
+ai_agent = AiAgent::Claude.new
+```
+
+Example passing the api_key to the initalizer:
+```ruby
+ai_agent = AiAgent::Claude.new(api_key: 'ANTHROPIC_API_KEY')
+```
 
 ## Usage
 
-To use this gem you'll need an API key for the agents that you want to use.
+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.
 
-Set your API keys as environment variables.
+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 }]
+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
+review = "The product quality is excellent and the customer service was very helpful!"
+response = ai_agent.analyze_sentiment(review, options: { model: Claude::Model::CLAUDE_CHEAPEST })
+ai_agent.format_response(response)
+```
+
+Named entity recognition:
+```ruby
+ai_agent = AiAgent::Claude.new
+abstract = "Anthropic released Claude 3.5 Sonnet on 21 June 2024."
+response = ai_agent.recognize_entities(abstract, options: { model: Claude::Model::CLAUDE_CHEAPEST })
+ai_agent.format_response(response)
+```
+
+Text summarization:
+```ruby
+ai_agent = AiAgent::Claude.new
+abstract = "A long message" # customise this for your own example
+response = ai_agent.summarize_text(abstract, strict: false, options: { model: Claude::Model::CLAUDE_SMARTEST })
+ai_agent.format_response(response)
+```
 
 ## Changelog
 

data/lib/ai_agent/ai_agent/claude.rb

@@ -9,16 +9,34 @@ module AiAgent
   CLAUDE = 'claude'.freeze
 
   class Claude < Base
-    def initialize
-      super
+    def initialize(api_key: nil, endpoint: nil, timeout: 60)
       self.agent = CLAUDE
+      self.api_key = api_key || ENV['ANTHROPIC_API_KEY']
+      self.endpoint = endpoint # nil for default as defined in claude/client
+      self.timeout = timeout
     end
 
     def client
       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
 
@@ -29,11 +47,7 @@ module AiAgent
     private
 
     def claude
-      @claude ||= ::Claude::Client.new(anthropic_api_key)
-    end
-
-    def anthropic_api_key
-      @anthropic_api_key ||= ENV['ANTHROPIC_API_KEY']
+      @claude ||= ::Claude::Client.new(api_key, endpoint: endpoint, timeout: timeout)
     end
   end
 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

@@ -4,6 +4,9 @@ require 'json'
 module AiAgent
   class Base
     attr_accessor :agent
+    attr_accessor :api_key
+    attr_accessor :endpoint
+    attr_accessor :timeout
 
     def initialize
       # be sure to set agent in the subclass initialize method
@@ -13,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)
@@ -23,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.1.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aiagent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Web Ventures Ltd
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies: []
 description: Ruby SDK for interacting with LLM agents such as OpenAI's ChatGPT, Anthropic's
   Claude, and Ollama.
@@ -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