soka-rails 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 956c0fc8a0ecef6e81f471a6674f4a0c7c5df800f720618ecf54a32c87583d1f
-  data.tar.gz: d7d16aff15e796d33c284bb77f1db2f7ff42ba61dbf3fb7f76ded2e87a0758d5
+  metadata.gz: 5bfac5b44ed7fdb83d9355212bf03c75131ec6acb1fd1a6eae3637bd8e809f4e
+  data.tar.gz: 93e686020ecea4fc2cdfce51bd46859d3d18885a49ec53a8a05bb5fb4ddcda72
 SHA512:
-  metadata.gz: fd259ec01dcb6ba6c760685a3d1f94bf0091a9298014f696c782cf7839e182651d1e9c44457ed9505bc76a6b048ab72a9bc9b16063c43b436a5b7d48ce98ad17
-  data.tar.gz: 3383aba5cdbf64703815efe55214ad63e9ae8d8aedcd6f845c97ef4c6382cf91ba8a9cd0217c75a4fa7db38fa62507072a3550d64c8098dadfa85fd97e0585d9
+  metadata.gz: a279aa038cf1447539bed9f8bef7a52e15c0c41443c660ff3677753274f9d34b7cf4faea593eb23a504b66c9afab7ea4f9eeab64634d6f63ff01bf3562a22d6d
+  data.tar.gz: 5719156f98210602c47b05c982c3866db95e622a250633d3e5182960b8f7e91ba98fb569c0cac520239a0f80d47490ddb90dc38bae7ef23dc3f3bd5a188b4892

data/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.4] - 2025-08-04
+
+### Added
+- Support for dynamic instructions in Soka v0.0.4
+- Ability to generate agent instructions dynamically via methods
+- Context-aware behavior based on runtime conditions (environment, time, user, etc.)
+- Updated README with dynamic instructions examples
+- Enhanced agent generator template with dynamic instructions examples
+
+## [0.0.3] - 2025-08-04
+
+### Added
+- Upgrade to Soka v0.0.3 with custom instructions and multilingual support
+
 ## [0.0.2] - 2025-08-01
 
 ### Fixed

data/DESIGN.md

@@ -478,7 +478,6 @@ module Soka
       def mock_ai_response(response_attrs = {})
         default_response = {
           final_answer: "Mocked answer",
-          confidence_score: 0.95,
           status: :completed,
           iterations: 1,
           thought_process: []
@@ -616,7 +615,6 @@ class ConversationsController < ApplicationController
   def build_response(result)
     {
       answer: result.final_answer,
-      confidence: result.confidence_score,
       status: result.status,
       metadata: {
         iterations: result.iterations,
@@ -652,7 +650,6 @@ class ProcessConversationJob < ApplicationJob
     user.conversations.create!(
       message: message,
       response: result.final_answer,
-      confidence: result.confidence_score,
       metadata: {
         iterations: result.iterations,
         thought_process: result.thought_process

data/README.md

@@ -26,6 +26,9 @@ Soka Rails is a Rails integration package for the Soka AI Agent Framework, provi
 - 🔄 **Rails Lifecycle Hooks**: Integrates with Rails logging and error tracking
 - 💾 **Session Memory Support**: Store conversation history in Rails sessions
 - 🔐 **Authentication Integration**: Works with Rails authentication systems
+- 🗣️ **Custom Instructions**: Customize agent personality and behavior
+- 🎯 **Dynamic Instructions**: Generate instructions dynamically via methods
+- 🌐 **Multilingual Thinking**: Support for reasoning in different languages
 
 ## Installation
 
@@ -91,7 +94,7 @@ class ConversationsController < ApplicationController
 
     render json: {
       answer: result.final_answer,
-      confidence: result.confidence_score
+      status: result.status
     }
   end
 end
@@ -130,6 +133,15 @@ class WeatherAgent < ApplicationAgent
   tool WeatherApiTool
   tool LocationTool
 
+  # Custom instructions
+  # instructions "You are a helpful weather assistant"
+
+  # Dynamic instructions via method
+  # instructions :generate_instructions
+
+  # Multilingual thinking
+  # think_in 'zh-TW'  # Think in Traditional Chinese
+
   # Rails integration hooks
   before_action :log_request
   on_error :notify_error_service
@@ -144,6 +156,15 @@ class WeatherAgent < ApplicationAgent
     Rails.error.report(error, context: context)
     :continue
   end
+
+  # Example of dynamic instructions method
+  # def generate_instructions
+  #   <<~PROMPT
+  #     You are a weather assistant for #{Rails.env} environment.
+  #     Current time: #{Time.zone.now}
+  #     User location: #{request&.location&.city || 'Unknown'}
+  #   PROMPT
+  # end
 end
 ```
 
@@ -194,6 +215,59 @@ class ConversationsController < ApplicationController
 end
 ```
 
+### Custom Instructions and Dynamic Instructions
+
+```ruby
+class CustomerSupportAgent < ApplicationAgent
+  # Static instructions
+  instructions <<~PROMPT
+    You are a friendly customer support agent.
+    Always be polite and helpful.
+    Use emojis when appropriate.
+  PROMPT
+
+  # OR Dynamic instructions via method
+  instructions :generate_context_aware_instructions
+
+  private
+
+  def generate_context_aware_instructions
+    business_hours = (9..17).include?(Time.zone.now.hour)
+
+    <<~PROMPT
+      You are a customer support agent for #{Rails.application.class.module_parent_name}.
+      Environment: #{Rails.env}
+      Current time: #{Time.zone.now.strftime('%Y-%m-%d %H:%M:%S %Z')}
+      Business hours: #{business_hours ? 'Yes' : 'No (after hours)'}
+      #{business_hours ? 'Provide immediate assistance.' : 'Inform about callback options.'}
+    PROMPT
+  end
+end
+```
+
+### Multilingual Thinking
+
+```ruby
+class GlobalSupportAgent < ApplicationAgent
+  # Set default thinking language
+  think_in 'zh-TW'  # Think in Traditional Chinese
+
+  # Or set dynamically at runtime
+  def initialize(options = {})
+    super
+    # Detect user's preferred language from session or request
+    self.think_in = detect_user_language
+  end
+
+  private
+
+  def detect_user_language
+    # Logic to detect language from session, user preferences, or request headers
+    session[:locale] || I18n.locale || 'en'
+  end
+end
+```
+
 ### Event Streaming
 
 ```ruby
@@ -243,6 +317,15 @@ class WeatherAgent < ApplicationAgent
   tool TemperatureTool
   tool HumidityTool
 
+  # Custom instructions
+  # instructions "You are a weather expert. Always provide temperature in both Celsius and Fahrenheit."
+
+  # Dynamic instructions via method
+  # instructions :generate_instructions
+
+  # Multilingual thinking
+  # think_in 'en'  # Supported: 'en', 'zh-TW', 'ja-JP', etc.
+
   # Configuration
   # max_iterations 10
   # timeout 30
@@ -389,7 +472,7 @@ end
 
 - Ruby: >= 3.4
 - Rails: >= 7.0
-- Soka: >= 1.0
+- Soka: >= 0.0.4
 
 ## Contributing
 

data/SPEC.md

@@ -291,7 +291,6 @@ class ConversationsController < ApplicationController
     
     render json: {
       answer: result.final_answer,
-      confidence: result.confidence_score,
       status: result.status
     }
   end

data/lib/generators/soka/agent/templates/agent.rb.tt

@@ -10,6 +10,15 @@ class <%= @agent_class_name %> < ApplicationAgent
   # tool YourTool
 <% end -%>
 
+  # Custom instructions
+  # instructions "You are a helpful assistant specialized in..."
+
+  # Dynamic instructions via method
+  # instructions :generate_instructions  # Reference a method for dynamic instructions
+
+  # Multilingual thinking
+  # think_in 'en'  # 'en', 'zh-TW', 'ja-JP', etc.
+
   # Configuration
   # max_iterations 10
   # timeout 30
@@ -22,4 +31,13 @@ class <%= @agent_class_name %> < ApplicationAgent
   # private
 
   # Implement your private methods here
+
+  # Example of dynamic instructions method
+  # def generate_instructions
+  #   <<~PROMPT
+  #     You are a #{Rails.env} environment assistant.
+  #     Current Time: #{Time.zone.now.strftime('%Y-%m-%d %H:%M:%S')}
+  #     User: #{current_user&.name || 'Guest'}
+  #   PROMPT
+  # end
 end

data/lib/generators/soka/tool/templates/tool_spec.rb.tt

@@ -15,14 +15,14 @@ RSpec.describe <%= @tool_class_name %>Tool, type: :tool do
       }
     end
 
-    it 'executes successfully with valid params' do
+    it 'calls successfully with valid params' do
       result = tool.call(**params)
 
       expect(result).to be_a(Hash)
       expect(result[:result]).to be_present
     end
 <% else -%>
-    it 'executes successfully' do
+    it 'calls successfully' do
       result = tool.call
 
       expect(result).to be_a(Hash)

data/lib/soka/rails/test_helpers.rb

@@ -19,7 +19,6 @@ module Soka
       def build_mock_response(attrs)
         default_response = {
           final_answer: 'Mocked answer',
-          confidence_score: 0.95,
           status: :completed,
           iterations: 1,
           thought_process: []
@@ -95,7 +94,6 @@ module Soka
         default_attrs = {
           status: :completed,
           final_answer: 'Success',
-          confidence_score: 0.95,
           iterations: 1
         }
 

data/lib/soka/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Soka
   module Rails
-    VERSION = '0.0.2'
+    VERSION = '0.0.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soka-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - jiunjiun
@@ -35,14 +35,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement