aiagent 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f54f71f8b08b031f351313bcf6fd253fdd2a588ef7d17da74115ff2b72561bb0
-  data.tar.gz: 2a8004689fc829d08872840029e8729be303aaf236f33500e8f979d8b8c4e92d
+  metadata.gz: 2ca59dbb48716e29658c4e73e94e75c2c017f4b1f7bfb5b3a1a7865c4411ebf1
+  data.tar.gz: aa1d848208b8a9205cab096d382fb5ca40ad051507d4a09e0ec5f52160c2474b
 SHA512:
-  metadata.gz: bf0f1f4447b4608769fdffe194bf210cd9f409bcf00c387c0e370466b2ca3188e3e3880075ac14267f62597ed62b2389632e7943e410004d80cedf82a0cab3f0
-  data.tar.gz: 44a6f23bfe09e4ce4e3a32ccbf8eecaa935d7b4b63aa59ffd98bb237a574731804036c51a79b42b14fd8a9113a23e4c8ad0b91484f1f938277eeb1f235049c68
+  metadata.gz: 42ca5e9c3e0234e6671afcf986d5525b1cb8fb9fd5fb00652e66e7072d424007c09b22c302065040ea1abc9b2c57c7e90acffa128c51adc7d7a2fa738259e6ff
+  data.tar.gz: e4789e27b79fe54fcafc800e47326a192dafcf57e3411fbdf4cf66a92834947d77b59e676ed83cdfd2e439067d471c6e97503763f3fb8f3572edd2ac34e47af9

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [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/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,66 @@ $ 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 Claude:
 
-Set your API keys as environment variables.
+```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)
+ai_agent.format_response(response)
+```
+
+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,9 +9,11 @@ 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
@@ -29,11 +31,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/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

data/lib/ai_agent/ruby/version.rb

@@ -2,6 +2,6 @@
 
 module AiAgent
   module Ruby
-    VERSION = "0.1.0"
+    VERSION = "0.2.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.2.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.