rach 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f427f0e11f94e869ea14d6d7ed35bd5d73311212fd958daa52b1d8964886fc3
-  data.tar.gz: b0fbf4e2dfcc18c9aa39c6e23b8ebc5edafa62deb125a4b0d25bb0c0eeb5ba4c
+  metadata.gz: 54430271658860452dad9e146c8aed72752de64c546a888b5784724bc47fb1c8
+  data.tar.gz: 34ea312840fa1b5aa08104f3f3696cacad5a2488039bd1d99e87c48c7949650b
 SHA512:
-  metadata.gz: 0abf7aa58e283fa66cf18b322c9711f250365760b6f77b25d1276e77daf28a0f0640f98050b0bc2ccee38b181735398572e21c95d3f0872a770e6f545ce40cd5
-  data.tar.gz: 2a2553158981ff4f425ada8381c3e61635f302faf5b88c9d952247a60ea126dda4ddc91440dd32324194a94a80d86aad283d0a74bc2a1b3c48066348447f96ae
+  metadata.gz: b7ced2382782e8f422d1c959f5ca6a7348110f542fd9d50cd9a350c3177575583a26641599ff5b584fba4f8fe6219b27bf2a610966a6bb941404026f97919516
+  data.tar.gz: 718302171ac286fe03df1030f745bcdac07e3b319bb09f15abb034d6258bf2f32a7c46ac2dfb6063d7ff385d4935968eb94ffd4a00a3f4b03708e57318f07d60

data/README.md

@@ -2,11 +2,125 @@
 
 A lightweight Ruby framework for OpenAI interactions, focusing on simplicity and clean design.
 
+## Installation
 
-## Configuration
+Add this line to your application's Gemfile:
 
-1. Copy the example environment file:
+```ruby
+gem 'rach'
 ```
-cp .env.example .env
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install rach
+```
+
+## Usage
+
+### Basic Chat
+
+```ruby
+require 'rach'
+client = Rach::Client.new(access_token: YOUR_OPENAI_API_KEY)
+response = client.chat("Hello, how are you?")
+puts response.content
+```
+
+### Conversations
+
+Rach supports stateful conversations with memory:
+
+```ruby
+require 'rach'
+
+client = Rach::Client.new(access_token: YOUR_OPENAI_API_KEY)
+convo = Rach::Conversation.new
+convo.system "You teach the German language."
+convo.user "Translate: There are two birds singing outside my window."
+
+response = client.chat(convo)
+response.content
+# => "Es gibt zwei Vögel, die draußen vor meinem Fenster singen."
+
+convo.add_response(response)
+
+# Continue the conversation...
+convo.user "What are the verbs in your translation?"
+client.chat(convo)
+
+
+# Remove the last message from the conversation history and continue
+convo.pop
+convo.user "Explain the structure of your translation."
+client.chat(convo)
 ```
-2. Set your OpenAI API key in the `.env` file.
+
+### Response Formatting
+
+Define structured response schemas for type-safe AI responses:
+
+```ruby
+class GermanTranslatorSchema
+  include Rach::ResponseFormat
+
+  def explain_structure
+    object do
+      array :structure_explanation do
+        items type: :string
+        description "A step by step explanation of the structure of the translation."
+      end
+      string :final_translation
+    end
+  end
+end
+
+response = client.chat(convo, response_format: GermanTranslatorSchema.render(:explain_structure))
+JSON.load(response.content)
+# => {"structure_explanation"=> ["The phrase starts with 'Es gibt' which translates to 'There are'. 'Es' is a pronoun that means 'it', and 'gibt' is the third person singular form of the verb 'geben' (to give), meaning 'there are' in this context.", "'zwei Vögel' means 'two birds'. 'zwei' is the number 'two' and 'Vögel' is the plural form of 'Vogel' (bird).", "The relative clause 'die draußen vor meinem Fenster singen' describes the birds. 'die' is a relative pronoun meaning 'that' or 'which',' 'draußen' means 'outside', and 'vor meinem Fenster' means 'in front of my window'.", "'singen' is the infinitive form of the verb 'sing' (to sing). It tells us what the birds are doing."], "final_translation"=>"Es gibt zwei Vögel, die draußen vor meinem Fenster singen."}
+```
+
+### Function Calling / Tools
+
+Rach supports OpenAI's function calling feature:
+
+```ruby
+class GetWeather
+  include Rach::Function
+
+  def function_name
+    "get_current_weather"
+  end
+
+  def function_description
+    "Get the current weather in a given location"
+  end
+
+  def schema
+    object do
+      string :location, description: "The city and state, e.g. San Francisco, CA"
+      string :unit, enum: %w[celsius fahrenheit]
+    end
+  end
+
+  def execute(location:, unit: "fahrenheit")
+    # Implementation of weather fetching logic
+    "The weather in #{location} is nice 🌞 #{unit}"
+  end
+end
+
+response = client.chat("What is the weather in San Francisco?", tools: [GetWeather.function_schema])
+response.tool_calls
+# => [{"id"=>"call_8v3MuUICwn0AjPRy1wZMCXtf",
+#   "type"=>"function",
+#   "function"=>{"name"=>"get_current_weather", "arguments"=>"{\"location\":\"San Francisco, CA\",\"unit\":\"celsius\"}"}}]
+```
+
+
+## License
+
+Rach is available as open source under the terms of the MIT License.

data/lib/rach/client.rb

@@ -10,6 +10,7 @@ module Rach
 
     def chat(prompt, response_format: nil, tools: nil)
       messages = format_messages(prompt)
+      formatted_tools = tools&.map(&:function_schema)
       
       response = Response.new(
         @client.chat(
@@ -17,7 +18,7 @@ module Rach
             model: @model,
             messages:,
             response_format:,
-            tools:,
+            tools: formatted_tools,
           }.compact
         )
       )

data/lib/rach/conversation.rb

@@ -39,11 +39,14 @@ module Rach
 
     def clear
       @messages.clear
-      self
     end
 
     def empty?
       @messages.empty?
     end
+
+    def pop
+      @messages.pop
+    end
   end
 end

data/lib/rach/function.rb

@@ -80,5 +80,11 @@ module Rach
     def function_description
       raise NotImplementedError, "#{self.class} must implement #function_description"
     end
+
+    def validate_arguments!(arguments)
+      unless schema.validate(arguments)
+        raise ArgumentError, "Invalid arguments for function #{function_name}"
+      end
+    end
   end
 end

data/lib/rach/response.rb

@@ -46,6 +46,23 @@ module Rach
       usage&.fetch("total_tokens", 0)
     end
 
+    def on_function(function_class = nil, &block)
+      return self unless function_call?
+
+      function = function_class.new
+      return self unless function.function_name == function_name
+
+      args = function_arguments.transform_keys(&:to_sym)
+      function.validate_arguments!(args)
+      block.call(function, args)
+      self
+    end
+
+    def on_content(&block)
+      block.call(content) if content
+      self
+    end
+
     private
 
     def message

data/lib/rach/version.rb

@@ -1,3 +1,3 @@
 module Rach
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rach
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roger Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2024-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -103,14 +103,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Orchestrate AI agents like a virtuoso