active_genie 0.29.1 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2f34c9574bf0d25b2411f3b65678fe3a83f243cf8f4d83f97964411ec737918
-  data.tar.gz: 19359a3fe3033791197b77adff4aba84346df4c7d16e6fa8c14f4cf5c08a274c
+  metadata.gz: a3798199139490fc67b7bd1e154c74ff7c53411bd035cd9e2fd1d9b46e676a90
+  data.tar.gz: 5d9be13a369c0a6116257822f75365241ea7f628e0bdc11af085ecb267cef806
 SHA512:
-  metadata.gz: 203d650dd794406004379de0a356681a42b008da14c9b3a2e902a54444114e9ebce78c14c5f1edfa4af961c4dcc8a6591ef07b4efef1016b62743a12ac021424
-  data.tar.gz: 8a72b957973e192998e80d25e26b4acfa1c719886d181d2052c3a1aa463f187f194ff2468d888c27b7e4aacadd12043def0ad40e79e3bb98bd9c061c48dc415b
+  metadata.gz: 1929da5851c827ef6b693aa4f66b6118a2cda72c1b7996e602e0b0abd0537d3ac8de4fcd58d55c34fcb30ac798b237e0dea2f42e1f2431f6b61594e74807a2fd
+  data.tar.gz: 4d8a653613a1782f8542a531abf23d0171e5e30d36d42bee1d756963d645113b9ee151206ae81ba34a053b408df945d4f98e1ef35e23fc2fc47023776961dee8

data/README.md

@@ -60,7 +60,7 @@ schema = {
 result = ActiveGenie::DataExtractor.call(
   text,
   schema,
-  config: { provider: :openai, model: 'gpt-4.1-mini' } # optional
+  config: { provider_name: :openai, model: 'gpt-4.1-mini' } # optional
 )
 # => {
 #      brand: "Nike",

data/VERSION

@@ -1 +1 @@
-0.29.1
+0.30.0

data/lib/active_genie/{battle/generalist.json → comparator/debate.json}

@@ -1,6 +1,6 @@
 {
-  "name": "battle_evaluation",
-  "description": "Evaluate a battle between player_a and player_b using predefined criteria and identify the winner.",
+  "name": "comparation_through_debate",
+  "description": "Evaluate a debate between player_a and player_b using predefined criteria and identify the winner.",
   "parameters": {
     "type": "object",
     "properties": {

data/lib/active_genie/{battle/generalist.prompt.md → comparator/debate.prompt.md}

@@ -1,4 +1,4 @@
-Based on two players, player_a and player_b, they will battle against each other based on criteria. Criteria are vital as they provide a clear metric to compare the players. Follow these criteria strictly.
+Based on two players, player_a and player_b, they will debate against each other based on criteria. Criteria are vital as they provide a clear metric to compare the players. Follow these criteria strictly.
 
 # Steps
 1. player_a presents their strengths and how they meet the criteria. Max of 100 words.

data/lib/active_genie/{battle/generalist.rb → comparator/debate.rb}

@@ -1,22 +1,20 @@
 # frozen_string_literal: true
 
-require_relative '../clients/unified_client'
+require_relative '../providers/unified_provider'
 
 module ActiveGenie
-  module Battle
-    # The Generalist class provides a foundation for evaluating battles between two players
+  module Comparator
+    # The Debate class provides a foundation for evaluating comparators between two players
     # using AI-powered evaluation. It determines a winner based on specified criteria,
     # analyzing how well each player meets the requirements.
     #
-    # The battle evaluation process compares two players' content against given criteria
+    # The comparator evaluation process compares two players' content against given criteria
     # and returns detailed feedback including the winner and reasoning for the decision.
     #
-    # @example Generalist usage with two players and criteria
-    #   Generalist.call("Player A content", "Player B content", "Evaluate keyword usage and pattern matching")
+    # @example Debate usage with two players and criteria
+    #   Debate.call("Player A content", "Player B content", "Evaluate keyword usage and pattern matching")
     #
-    class Generalist
-      BattleResponse = Struct.new(:winner, :loser, :reasoning, :raw, keyword_init: true)
-
+    class Debate
       def self.call(...)
         new(...).call
       end
@@ -24,8 +22,8 @@ module ActiveGenie
       # @param player_a [String] The content or submission from the first player
       # @param player_b [String] The content or submission from the second player
       # @param criteria [String] The evaluation criteria or rules to assess against
-      # @param config [Hash] Additional configuration options that modify the battle evaluation behavior
-      # @return [BattleResponse] The evaluation result containing the winner and reasoning
+      # @param config [Hash] Additional configuration options that modify the comparator evaluation behavior
+      # @return [ComparatorResponse] The evaluation result containing the winner and reasoning
       #   @return [String] :winner The winner, either player_a or player_b
       #   @return [String] :reasoning Detailed explanation of why the winner was chosen
       #   @return [String] :what_could_be_changed_to_avoid_draw A suggestion on how to avoid a draw
@@ -36,7 +34,7 @@ module ActiveGenie
         @config = ActiveGenie.configuration.merge(config)
       end
 
-      # @return [BattleResponse] The evaluation result containing the winner and reasoning
+      # @return [ComparatorResponse] The evaluation result containing the winner and reasoning
       def call
         messages = [
           {  role: 'system', content: PROMPT },
@@ -45,7 +43,7 @@ module ActiveGenie
           {  role: 'user', content: "criteria: #{@criteria}" }
         ]
 
-        response = ::ActiveGenie::Clients::UnifiedClient.function_calling(
+        response = ::ActiveGenie::Providers::UnifiedProvider.function_calling(
           messages,
           FUNCTION,
           config: @config
@@ -54,8 +52,8 @@ module ActiveGenie
         response_formatted(response)
       end
 
-      PROMPT = File.read(File.join(__dir__, 'generalist.prompt.md'))
-      FUNCTION = JSON.parse(File.read(File.join(__dir__, 'generalist.json')), symbolize_names: true)
+      PROMPT = File.read(File.join(__dir__, 'debate.prompt.md'))
+      FUNCTION = JSON.parse(File.read(File.join(__dir__, 'debate.json')), symbolize_names: true)
 
       private
 
@@ -66,19 +64,20 @@ module ActiveGenie
                         end
         reasoning = response['impartial_judge_winner_reasoning']
 
-        battle_response = BattleResponse.new(winner:, loser:, reasoning:, raw: response)
-        log_battle(battle_response)
+        comparator_response = ActiveGenie::Comparator::ComparatorResponse.new(winner:, loser:, reasoning:,
+                                                                              raw: response)
+        log_comparator(comparator_response)
 
-        battle_response
+        comparator_response
       end
 
-      def log_battle(battle_response)
+      def log_comparator(comparator_response)
         @config.logger.call(
-          code: :battle,
+          code: :comparator,
           player_a: @player_a[0..30],
           player_b: @player_b[0..30],
           criteria: @criteria[0..30],
-          **battle_response.to_h
+          **comparator_response.to_h
         )
       end
     end

data/lib/active_genie/{battle → comparator}/fight.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require_relative '../clients/unified_client'
-require_relative 'generalist'
+require_relative '../providers/unified_provider'
+require_relative 'debate'
 
 module ActiveGenie
-  module Battle
-    # The Fight class are battle specialized in a fight between two fighters, like martial arts, heroes, characters.
+  module Comparator
+    # The Fight class are comparation specialized in a fight between two fighters, like martial arts, heroes, characters.
     # The fight evaluation process simulate a fight using words, techniques, strategies, and reasoning.
     #
     # @example Fight usage with two fighters and criteria
     #   Fight.call("Naruto", "Sasuke", "How can win without using jutsu?")
     #
-    class Fight < Generalist
-      # @return [BattleResponse] The evaluation result containing the winner and reasoning
+    class Fight < Debate
+      # @return [ComparatorResponse] The evaluation result containing the winner and reasoning
       def call
         messages = [
           {  role: 'system', content: PROMPT },
@@ -21,7 +21,7 @@ module ActiveGenie
           {  role: 'user', content: "criteria: #{@criteria}" }
         ]
 
-        response = ::ActiveGenie::Clients::UnifiedClient.function_calling(
+        response = ::ActiveGenie::Providers::UnifiedProvider.function_calling(
           messages,
           FUNCTION,
           config: @config

data/lib/active_genie/comparator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'comparator/debate'
+require_relative 'comparator/fight'
+
+module ActiveGenie
+  module Comparator
+    module_function
+
+    ComparatorResponse = Struct.new(:winner, :loser, :reasoning, :raw, keyword_init: true)
+
+    def call(...)
+      Debate.call(...)
+    end
+
+    def by_debate(...)
+      Debate.call(...)
+    end
+
+    def by_fight(...)
+      Fight.call(...)
+    end
+  end
+end

data/lib/active_genie/{config/scoring_config.rb → configs/comparator_config.rb}

@@ -3,7 +3,7 @@
 module ActiveGenie
   module Config
     # rubocop:disable Lint/EmptyClass
-    class ScoringConfig
+    class ComparatorConfig
     end
     # rubocop:enable Lint/EmptyClass
   end

data/lib/active_genie/{config/data_extractor_config.rb → configs/extractor_config.rb}

@@ -2,7 +2,7 @@
 
 module ActiveGenie
   module Config
-    class DataExtractorConfig
+    class ExtractorConfig
       attr_accessor :with_explanation, :min_accuracy, :verbose
 
       def initialize

data/lib/active_genie/{config/factory_config.rb → configs/lister_config.rb}

@@ -2,7 +2,7 @@
 
 module ActiveGenie
   module Config
-    class FactoryConfig
+    class ListerConfig
       attr_accessor :number_of_items
 
       def initialize

data/lib/active_genie/{config → configs}/llm_config.rb

@@ -4,13 +4,13 @@ module ActiveGenie
   module Config
     class LlmConfig
       attr_accessor :model, :temperature, :max_tokens, :max_retries, :retry_delay,
-                    :model_tier, :read_timeout, :open_timeout, :client
-      attr_reader :provider
+                    :model_tier, :read_timeout, :open_timeout, :provider
+      attr_reader :provider_name
 
       def initialize
         @model = nil
+        @provider_name = nil
         @provider = nil
-        @client = nil
         @temperature = 0
         @max_tokens = 4096
         @max_retries = nil
@@ -20,10 +20,10 @@ module ActiveGenie
         @open_timeout = nil
       end
 
-      def provider=(provider)
-        return if provider.nil? || provider.empty?
+      def provider_name=(provider_name)
+        return if provider_name.nil? || provider_name.empty?
 
-        @provider = provider.to_s.downcase.strip.to_sym
+        @provider_name = provider_name.to_s.downcase.strip.to_sym
       end
 
       def merge(config_params = {})

data/lib/active_genie/{config/ranking_config.rb → configs/ranker_config.rb}

@@ -2,7 +2,7 @@
 
 module ActiveGenie
   module Config
-    class RankingConfig
+    class RankerConfig
       attr_accessor :score_variation_threshold
 
       def initialize

data/lib/active_genie/{config/battle_config.rb → configs/scorer_config.rb}

@@ -3,7 +3,7 @@
 module ActiveGenie
   module Config
     # rubocop:disable Lint/EmptyClass
-    class BattleConfig
+    class ScorerConfig
     end
     # rubocop:enable Lint/EmptyClass
   end

data/lib/active_genie/configuration.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'config/providers_config'
-require_relative 'config/log_config'
-require_relative 'config/ranking_config'
-require_relative 'config/scoring_config'
-require_relative 'config/data_extractor_config'
-require_relative 'config/battle_config'
-require_relative 'config/llm_config'
-require_relative 'config/factory_config'
+require_relative 'configs/comparator_config'
+require_relative 'configs/extractor_config'
+require_relative 'configs/lister_config'
+require_relative 'configs/llm_config'
+require_relative 'configs/log_config'
+require_relative 'configs/providers_config'
+require_relative 'configs/ranker_config'
+require_relative 'configs/scorer_config'
 
 module ActiveGenie
   class Configuration
@@ -19,24 +19,24 @@ module ActiveGenie
       @providers ||= Config::ProvidersConfig.new
     end
 
-    def ranking
-      @ranking ||= Config::RankingConfig.new
+    def ranker
+      @ranker ||= Config::RankerConfig.new
     end
 
-    def scoring
-      @scoring ||= Config::ScoringConfig.new
+    def scorer
+      @scorer ||= Config::ScorerConfig.new
     end
 
-    def data_extractor
-      @data_extractor ||= Config::DataExtractorConfig.new
+    def extractor
+      @extractor ||= Config::ExtractorConfig.new
     end
 
-    def battle
-      @battle ||= Config::BattleConfig.new
+    def comparator
+      @comparator ||= Config::ComparatorConfig.new
     end
 
-    def factory
-      @factory ||= Config::FactoryConfig.new
+    def lister
+      @lister ||= Config::ListerConfig.new
     end
 
     def llm
@@ -47,7 +47,7 @@ module ActiveGenie
       @logger ||= ActiveGenie::Logger.new(log_config: log)
     end
 
-    SUB_CONFIGS = %w[log providers llm ranking scoring data_extractor battle factory].freeze
+    SUB_CONFIGS = %w[log providers llm ranker scorer extractor comparator lister].freeze
 
     def merge(config_params = {})
       return config_params if config_params.is_a?(Configuration)

data/lib/active_genie/errors/invalid_provider_error.rb

@@ -17,7 +17,7 @@ module ActiveGenie
 
       2. Or pass configuration directly to the method call:
          ```ruby
-         ActiveGenie::DataExtraction.call(
+         ActiveGenie::Extraction.call(
            arg1,
            arg2,
            config: {

data/lib/active_genie/{data_extractor/generalist.rb → extractor/explanation.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative '../clients/unified_client'
+require_relative '../providers/unified_provider'
 
 module ActiveGenie
-  module DataExtractor
-    class Generalist
+  module Extractor
+    class Explanation
       def self.call(...)
         new(...).call
       end
@@ -25,7 +25,7 @@ module ActiveGenie
       #     age: { type: 'integer', description: 'Age in years' }
       #   }
       #   text = "John Doe is 25 years old"
-      #   DataExtractor.call(text, schema)
+      #   Extractor.with_explanation(text, schema)
       #   # => { name: "John Doe", name_explanation: "Found directly in text",
       #   #      age: 25, age_explanation: "Explicitly stated as 25 years old" }
       def initialize(text, data_to_extract, config: {})
@@ -42,7 +42,7 @@ module ActiveGenie
 
         properties = data_to_extract_with_explanation
 
-        function = JSON.parse(File.read(File.join(__dir__, 'generalist.json')), symbolize_names: true)
+        function = JSON.parse(File.read(File.join(__dir__, 'explanation.json')), symbolize_names: true)
         function[:parameters][:properties] = properties
         function[:parameters][:required] = properties.keys
 
@@ -54,7 +54,7 @@ module ActiveGenie
       private
 
       def data_to_extract_with_explanation
-        return @data_to_extract unless @config.data_extractor.with_explanation
+        return @data_to_extract unless @config.extractor.with_explanation
 
         with_explanation = {}
 
@@ -81,7 +81,7 @@ module ActiveGenie
       end
 
       def function_calling(messages, function)
-        response = ::ActiveGenie::Clients::UnifiedClient.function_calling(
+        response = ::ActiveGenie::Providers::UnifiedProvider.function_calling(
           messages,
           function,
           config: @config
@@ -89,7 +89,7 @@ module ActiveGenie
 
         @config.logger.call(
           {
-            code: :data_extractor,
+            code: :extractor,
             text: @text[0..30],
             data_to_extract: function[:parameters][:properties],
             extracted_data: response
@@ -100,7 +100,7 @@ module ActiveGenie
       end
 
       def simplify_response(response)
-        return response if @config.data_extractor.verbose
+        return response if @config.extractor.verbose
 
         simplified_response = {}
 
@@ -115,11 +115,11 @@ module ActiveGenie
       end
 
       def min_accuracy
-        @config.data_extractor.min_accuracy # default 70
+        @config.extractor.min_accuracy # default 70
       end
 
       def prompt
-        File.read(File.join(__dir__, 'generalist.prompt.md'))
+        File.read(File.join(__dir__, 'explanation.prompt.md'))
       end
     end
   end

data/lib/active_genie/{data_extractor/from_informal.rb → extractor/litote.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'generalist'
+require_relative 'explanation'
 
 module ActiveGenie
-  module DataExtractor
-    class FromInformal
+  module Extractor
+    class Litote
       def self.call(...)
         new(...).call
       end
@@ -24,7 +24,7 @@ module ActiveGenie
       # @example Analyze text with litote
       #   text = "The weather isn't bad today"
       #   schema = { mood: { type: 'string', description: 'The mood of the message' } }
-      #   DataExtractor.from_informal(text, schema)
+      #   Extractor.with_litote(text, schema)
       #   # => { mood: "positive", mood_explanation: "Speaker views weather favorably",
       #   #      message_litote: true,
       #   #      litote_rephrased: "The weather is good today" }
@@ -35,7 +35,7 @@ module ActiveGenie
       end
 
       def call
-        response = Generalist.call(@text, data_to_extract_with_litote, config: @config)
+        response = Generalist.call(@text, extract_with_litote, config: @config)
 
         if response[:message_litote]
           response = Generalist.call(response[:litote_rephrased], @data_to_extract, config: @config)
@@ -46,8 +46,8 @@ module ActiveGenie
 
       private
 
-      def data_to_extract_with_litote
-        parameters = JSON.parse(File.read(File.join(__dir__, 'from_informal.json')), symbolize_names: true)
+      def extract_with_litote
+        parameters = JSON.parse(File.read(File.join(__dir__, 'with_litote.json')), symbolize_names: true)
 
         @data_to_extract.merge(parameters)
       end

data/lib/active_genie/extractor.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'extractor/explanation'
+require_relative 'extractor/litote'
+
+module ActiveGenie
+  module Extractor
+    module_function
+
+    def call(...)
+      Explanation.call(...)
+    end
+
+    def with_explanation(...)
+      Explanation.call(...)
+    end
+
+    def with_litote(...)
+      Litote.call(...)
+    end
+  end
+end

data/lib/active_genie/{factory → lister}/feud.rb

@@ -3,8 +3,8 @@
 require_relative '../clients/unified_client'
 
 module ActiveGenie
-  module Factory
-    # The Factory::Feud class provides a foundation for generating a list of items for a given theme
+  module Lister
+    # The Lister::Feud class provides a foundation for generating a list of items for a given theme
     #
     # @example Feud usage with two players and criteria
     #   Feud.call("Industries that are most likely to be affected by climate change")
@@ -15,14 +15,14 @@ module ActiveGenie
       end
 
       # @param theme [String] The theme for the feud
-      # @param config [Hash] Additional configuration options that modify the battle evaluation behavior
+      # @param config [Hash] Additional configuration options
       # @return [Array of strings] List of items
       def initialize(theme, config: {})
         @theme = theme
         @config = ActiveGenie.configuration.merge(config)
       end
 
-      # @return [Array] The list of items
+      # @return [Array of strings] The list of items
       def call
         messages = [
           {  role: 'system', content: PROMPT },
@@ -37,7 +37,7 @@ module ActiveGenie
         )
 
         log_feud(response)
-        response['items']
+        response['items'] || []
       end
 
       PROMPT = File.read(File.join(__dir__, 'feud.prompt.md'))
@@ -46,7 +46,7 @@ module ActiveGenie
       private
 
       def number_of_items
-        @config.factory.number_of_items
+        @config.lister.number_of_items
       end
 
       def log_feud(response)

data/lib/active_genie/lister/juries.prompt.md

@@ -0,0 +1,20 @@
+Emulate the game "Family Feud": For a given theme, reason about the general public's most common answers impersonating a survey of average people's opinions and generate an ordered, survey-style answer list.
+
+- Before producing the answer list, internally consider: If a group of average people were surveyed on this theme, which answers would be mentioned most frequently?.
+
+# Output Format
+
+A numbered list in plain text
+
+# Example
+
+Example for the theme "Favorite Fast Foods":
+1. Pizza
+2. Hamburgers
+3. Hot Dogs
+4. French Fries
+
+# Notes
+
+- Always impersonate a "Family Feud" survey: order is critical most likely answers should come first.
+- Judge each item by their general public reputation and cultural impact.

data/lib/active_genie/lister/juries.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative '../clients/unified_client'
+
+module ActiveGenie
+  module Lister
+    # The Juries class intelligently suggests appropriate jury roles
+    # for evaluating text content based on specific criteria. It uses AI to analyze
+    # the content and criteria to identify the most suitable subject matter experts.
+    #
+    # The class ensures a balanced and comprehensive review process by recommending
+    # three distinct jury roles with complementary expertise and perspectives.
+    #
+    # @example Getting jury for technical content
+    #   Juries.call("Technical documentation about API design",
+    #                           "Evaluate technical accuracy and clarity")
+    #   # => { jury1: "API Architect", jury2: "Technical Writer",
+    #   #      jury3: "Developer Advocate", reasoning: "..." }
+    #
+    class Juries
+      def self.call(...)
+        new(...).call
+      end
+
+      # Initializes a new jury recommendation instance
+      #
+      # @param text [String] The text content to analyze for jury recommendations
+      # @param criteria [String] The evaluation criteria that will guide jury selection
+      # @param config [Hash] Additional configuration config that modify the recommendation process
+      def initialize(text, criteria, config: {})
+        @text = text
+        @criteria = criteria
+        @config = ActiveGenie.configuration.merge(config)
+      end
+
+      def call
+        messages = [
+          {  role: 'system', content: prompt },
+          {  role: 'user', content: "<criteria> #{@criteria}</criteria>" },
+          {  role: 'user', content: "<text-to-score>#{@text}</text-to-score>" }
+        ]
+
+        function = {
+          name: 'identify_jury',
+          description: 'Discover a list of juries based on the text and given criteria.',
+          parameters: {
+            type: 'object',
+            properties: {
+              reasoning: { type: 'string' },
+              juries: {
+                type: 'array',
+                description: 'The list of best juries',
+                items: {
+                  type: 'string'
+                }
+              }
+            },
+            required: %w[reasoning juries]
+          }
+        }
+
+        result = client.function_calling(
+          messages,
+          function,
+          config: @config
+        )
+
+        result['juries'] || []
+      end
+
+      private
+
+      def client
+        ::ActiveGenie::Clients::UnifiedClient
+      end
+
+      def prompt
+        @prompt ||= File.read(File.join(__dir__, 'juries.prompt.md'))
+      end
+    end
+  end
+end