sublayer 0.0.7 → 0.1.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ead9b290805b3d7e173f8e613dd4670bdd304a094cb7a00505ac9d94285b9b
-  data.tar.gz: 89eba4a05eebb012013a68e06f4d44e8a1710db0ea8a808ed03557241f4baf74
+  metadata.gz: 5a723acaec8ce50c64470d067dc29769fb8efe9415e4a867507272ef8961e687
+  data.tar.gz: 76508d4f490e5d9601d3827e35191b20ba7887e2086696bb610567e0f49639bd
 SHA512:
-  metadata.gz: a6f07414c4a7a2798f2b93133bd921cae8ffe380104f813564109ab16b985dd58c416f6b176f33d75910898b56d47ea98262a1f1035071cb29dddf2f53277b82
-  data.tar.gz: 45953c8a3a63c526bd310f4928a1570210e54e6e1be5718ff50b28041a8e9e93ca175d8d984ca6abd8aa729b87f5c84bf922e547c6a8f22ef62272bd240eade2
+  metadata.gz: 983e31c6d8b85a6116accf2b7eb395b257e79de967e79f4046ddfacf046522bc274335e931e8665f67864704fd2af7b331cd93cc294f50d9533f44bf99d94f39
+  data.tar.gz: 3a18adf3d93a074897855874780f7ae0205ed5de3541923f5711a238ab0823fadedb3a0a82fe32c87cbca5da918656d0fa9d982bb2a3ef1651a5a606f5647d81

data/README.md

@@ -6,6 +6,20 @@ powered applications in Ruby.
 
 For more detailed documentation visit our documentation site: [https://docs.sublayer.com](https://docs.sublayer.com).
 
+## Note on Versioning
+
+Pre-1.0 we anticipate many breaking changes to the API. Our current plan is to
+keep breaking changes to minor, 0.x releases, and patch releases (0.x.y) will be used
+for new features and bug fixes.
+
+To maintain stability in your application, we recommend pinning the version of
+Sublayer in your Gemfile to a specific minor version. For example, to pin to
+version 0.1.x, you would add the following line to your Gemfile:
+
+```ruby
+gem 'sublayer', '~> 0.1'
+```
+
 ## Installation
 
 Install the gem by running the following commands:
@@ -15,7 +29,7 @@ Install the gem by running the following commands:
 Or add this line to your application's Gemfile:
 
 ```ruby
-gem 'sublayer'
+gem 'sublayer', '~> 0.1'
 ```
 
 ## Choose your AI Model
@@ -59,72 +73,6 @@ Sublayer.configuration.ai_provider = Sublayer::Providers::Claude
 Sublayer.configuration.ai_model ="claude-3-opus-20240229"
 ```
 
-### Groq
-
-Expects you to have a Groq API key set in the `GROQ_API_KEY` environment variable.
-
-Visit [Groq Console](https://console.groq.com/) to get an API key.
-
-Usage:
-```ruby
-Sublayer.configuration.ai_provider = Sublayer::Providers::Groq
-Sublayer.configuration.ai_model = "mixtral-8x7b-32768"
-```
-
-### Local
-
-If you've never run a local model before see the [Local Model Quickstart](#local-model-quickstart) below. Know that local models take several GB of space.
-
-The model you use must have the ChatML formatted v1/chat/completions endpoint to work with sublayer (many models do by default)
-
-Usage:
-
-Run your local model on http://localhost:8080 and then set:
-```ruby
-Sublayer.configuration.ai_provider = Sublayer::Providers::Local
-Sublayer.configuration.ai_model = "LLaMA_CPP"
-```
-
-#### Local Model Quickstart:
-
-Instructions to run a local model
-
-1. Setting up Llamafile
-
-  ```bash
-  cd where/you/keep/your/projects
-  git clone git@github.com:Mozilla-Ocho/llamafile.git
-  cd llamafile
-  ```
-
-  Download: https://cosmo.zip/pub/cosmos/bin/make (windows users need this too: https://justine.lol/cosmo3/)
-
-  ```bash
-  # within llamafile directory
-  chmod +x path/to/the/downloaded/make
-  path/to/the/downloaded/make -j8
-  sudo path/to/the/downloaded/make install PREFIX=/usr/local
-  ```
-  You can now run llamfile
-
-2. Downloading Model
-
-  click [here](https://huggingface.co/NousResearch/Hermes-2-Pro-Mistral-7B-GGUF/resolve/main/Hermes-2-Pro-Mistral-7B.Q5_K_M.gguf?download=true) to download Mistral_7b.Q5_K_M (5.13 GB)
-
-3. Running Llamafile with a model
-
-  ```bash
-  llamafile -ngl 9999 -m path/to/the/downloaded/Hermes-2-Pro-Mistral-7B.Q5_K_M.gguf --host 0.0.0.0 -c 4096
-  ```
-
-  You are now running a local model on http://localhost:8080
-
-#### Recommended Settings for Apple M1 users:
-```bash
-llamafile -ngl 9999 -m Hermes-2-Pro-Mistral-7B.Q5_K_M.gguf --host 0.0.0.0 --nobrowser -c 2048 --gpu APPLE -t 12
-```
-run `sysctl -n hw.logicalcpu` to see what number to give the `-t` threads option
-
 ## Concepts
 
 ### Generators
@@ -189,11 +137,3 @@ base for generating new code.
 
 - [Clag](https://github.com/sublayerapp/clag) - A ruby gem that generates
   command line commands from a simple description right in your terminal.
-
-## Development
-
-TBD
-
-## Contributing
-
-TBD

data/lib/sublayer/components/output_adapters/single_string.rb

@@ -2,41 +2,15 @@ module Sublayer
   module Components
     module OutputAdapters
       class SingleString
-        attr_reader :name
+        attr_reader :name, :description
 
         def initialize(options)
           @name = options[:name]
           @description = options[:description]
         end
 
-        def to_hash
-          {
-            name: @name,
-            description: @description,
-            parameters: {
-              type: "object",
-              properties: {
-                @name => {
-                  type: "string",
-                  description: @description
-                }
-              }
-            }
-          }
-        end
-
-        def to_xml
-          <<-XML
-            <tool_description>
-              <tool_name>#{@name}</tool_name>
-              <tool_description>#{@description}</tool_description>
-              <parameters>
-                <name>#{@name}</name>
-                <type>string</type>
-                <description>#{@description}</description>
-              </parameters>
-            </tool_description>
-          XML
+        def properties
+          [OpenStruct.new(name: @name, type: 'string', description: @description, required: true)]
         end
       end
     end

data/lib/sublayer/components/output_adapters/string_selection_from_list.rb

@@ -0,0 +1,30 @@
+module Sublayer
+  module Components
+    module OutputAdapters
+      class StringSelectionFromList
+        attr_reader :name, :description, :options
+
+        def initialize(options)
+          @name = options[:name]
+          @description = options[:description]
+          @list = options[:options]
+        end
+
+        def properties
+          [OpenStruct.new(name: @name, type: 'string', description: @description, required: true, enum: @list)]
+        end
+
+        def load_instance_data(generator)
+          case @list
+          when Proc
+            @list = generator.instance_exec(&@list)
+          when Symbol
+            @list = generator.send(@list)
+          else
+            @list
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sublayer/generators/base.rb

@@ -9,6 +9,7 @@ module Sublayer
       end
 
       def generate
+        self.class::OUTPUT_ADAPTER.load_instance_data(self) if self.class::OUTPUT_ADAPTER.respond_to?(:load_instance_data)
         @results = Sublayer.configuration.ai_provider.call(prompt: prompt, output_adapter: self.class::OUTPUT_ADAPTER)
       end
     end

data/lib/sublayer/generators/examples/route_selection_from_user_intent_generator.rb

@@ -0,0 +1,29 @@
+class RouteSelectionFromUserIntentGenerator < Sublayer::Generators::Base
+  llm_output_adapter type: :string_selection_from_list,
+    name: "route",
+    description: "A route selected from the list",
+    options: :available_routes
+
+  def initialize(user_intent:)
+    @user_intent = user_intent
+  end
+
+  def generate
+    super
+  end
+
+  def available_routes
+    ["GET /", "GET /users", "GET /users/:id", "POST /users", "PUT /users/:id", "DELETE /users/:id"]
+  end
+
+  def prompt
+    <<-PROMPT
+        You are skilled at selecting routes based on user intent.
+
+        Your task is to choose a route based on the following intent:
+
+        The user's intent is:
+        #{@user_intent}
+    PROMPT
+  end
+end

data/lib/sublayer/generators/examples/sentiment_from_text_generator.rb

@@ -0,0 +1,26 @@
+class SentimentFromTextGenerator < Sublayer::Generators::Base
+  llm_output_adapter type: :string_selection_from_list,
+    name: "sentiment_value",
+    description: "A sentiment value from the list",
+    options: -> { @sentiment_options }
+
+  def initialize(text:, sentiment_options:)
+    @text = text
+    @sentiment_options = sentiment_options
+  end
+
+  def generate
+    super
+  end
+
+  def prompt
+    <<-PROMPT
+        You are an expert at determining sentiment from text.
+
+        You are tasked with analyzing the following text and determining its sentiment value.
+
+        The text is:
+        #{@text}
+    PROMPT
+  end
+end

data/lib/sublayer/providers/claude.rb

@@ -5,49 +5,49 @@ module Sublayer
   module Providers
     class Claude
       def self.call(prompt:, output_adapter:)
-        system_prompt = <<-PROMPT
-        In this environment you have access to a set of tools you can use to answer the user's question.
-
-        You may call them like this:
-        <function_calls>
-        <invoke>
-          <tool_name>$TOOL_NAME</tool_name>
-          <parameters>
-          <$PARAMETER_NAME>$PARAMETER_VALUE</$PARAMETER_NAME>
-          ...
-          </parameters>
-        </invoke>
-        </function_calls>
-
-        Here are the tools available:
-        <tools>
-        #{output_adapter.to_xml}
-        </tools>
-
-        Respond only with valid xml. The entire response should be wrapped in a <response> tag. Any additional information not inside a tool call should go in a <scratch> tag.
-        PROMPT
-
         response = HTTParty.post(
           "https://api.anthropic.com/v1/messages",
           headers: {
             "x-api-key": ENV.fetch("ANTHROPIC_API_KEY"),
             "anthropic-version": "2023-06-01",
-            "content-type": "application/json"
+            "content-type": "application/json",
+            "anthropic-beta": "tools-2024-04-04"
           },
           body: {
             model: Sublayer.configuration.ai_model,
             max_tokens: 4096,
-            system: system_prompt,
-            messages: [ { "role": "user", "content": prompt }]
+            tools: [
+              {
+                name: output_adapter.name,
+                description: output_adapter.description,
+                input_schema: {
+                  type: "object",
+                  properties: format_properties(output_adapter),
+                  required: output_adapter.properties.select(&:required).map(&:name)
+                }
+              }
+            ],
+            messages: [{ "role": "user", "content": prompt }]
           }.to_json
         )
         raise "Error generating with Claude, error: #{response.body}" unless response.code == 200
 
-        text_containing_xml = JSON.parse(response.body).dig("content", 0, "text")
-        function_output = Nokogiri::HTML.parse(text_containing_xml.match(/\<#{output_adapter.name}\>(.*?)\<\/#{output_adapter.name}\>/m)[1]).text
+        function_input = JSON.parse(response.body).dig("content").find {|content| content['type'] == 'tool_use'}.dig("input")
+        function_input[output_adapter.name]
+      end
+
+      private
+      def self.format_properties(output_adapter)
+        output_adapter.properties.each_with_object({}) do |property, hash|
+          hash[property.name] = {
+            type: property.type,
+            description: property.description
+          }
 
-        raise "Claude did not format response, error: #{response.body}" unless function_output
-        return function_output
+          if property.enum
+            hash[property.name][:enum] = property.enum
+          end
+        end
       end
     end
   end

data/lib/sublayer/providers/gemini.rb

@@ -21,9 +21,13 @@ module Sublayer
 
         Here are the tools available:
         <tools>
-          <tool>
-            #{output_adapter.to_xml}
-          </tool>
+          <tool_description>
+            <tool_name>#{output_adapter.name}</tool_name>
+            <tool_description>#{output_adapter.description}</tool_description>
+            <parameters>
+              #{format_properties(output_adapter)}
+            </parameters>
+          </tool_description>
         </tools>
 
         Respond only with valid xml.
@@ -49,6 +53,17 @@ module Sublayer
         raise "Gemini did not format response, error: #{response.body}" unless tool_output
         return tool_output
       end
+
+      private
+      def self.format_properties(output_adapter)
+        output_adapter.properties.each_with_object("") do |property, xml|
+          xml << "<name>#{property.name}</name>"
+          xml << "<type>#{property.type}</type>"
+          xml << "<description>#{property.description}</description>"
+          xml << "<required>#{property.required}</required>"
+          xml << "<enum>#{property.enum}</enum>" if property.enum
+        end
+      end
     end
   end
 end

data/lib/sublayer/providers/open_ai.rb

@@ -16,18 +16,44 @@ module Sublayer
                 "content": prompt
               }
             ],
-            function_call: { name: output_adapter.name },
-            functions: [
-              output_adapter.to_hash
+            tool_choice: { type: "function", function: { name: output_adapter.name }},
+            tools: [
+              {
+                type: "function",
+                function: {
+                  name: output_adapter.name,
+                  description: output_adapter.description,
+                  parameters: {
+                    type: "object",
+                    properties: OpenAI.format_properties(output_adapter)
+                  },
+                  required: [output_adapter.properties.select(&:required).map(&:name)]
+                }
+              }
             ]
+
           })
 
         message = response.dig("choices", 0, "message")
-        raise "No function called" unless message["function_call"]
 
-        function_name = message.dig("function_call", output_adapter.name)
-        args_from_llm = message.dig("function_call", "arguments")
-        JSON.parse(args_from_llm)[output_adapter.name]
+        raise "No function called" unless message["tool_calls"].length > 0
+
+        function_body = message.dig("tool_calls", 0, "function", "arguments")
+        JSON.parse(function_body)[output_adapter.name]
+      end
+
+      private
+      def self.format_properties(output_adapter)
+        output_adapter.properties.each_with_object({}) do |property, hash|
+          hash[property.name] = {
+            type: property.type,
+            description: property.description
+          }
+
+          if property.enum
+            hash[property.name][:enum] = property.enum
+          end
+        end
       end
     end
   end

data/lib/sublayer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sublayer
-  VERSION = "0.0.7"
+  VERSION = "0.1.0-alpha"
 end

data/sublayer.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "colorize"
   spec.add_dependency "activesupport"
   spec.add_dependency "zeitwerk"
-  spec.add_dependency "nokogiri"
+  spec.add_dependency "nokogiri", "~> 1.16.5"
   spec.add_dependency "httparty"
 
   spec.add_development_dependency "rspec", "~> 3.12"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sublayer
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0.pre.alpha
 platform: ruby
 authors:
 - Scott Werner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -70,16 +70,16 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.16.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.16.5
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -180,15 +180,16 @@ files:
 - lib/sublayer/agents/base.rb
 - lib/sublayer/components/output_adapters.rb
 - lib/sublayer/components/output_adapters/single_string.rb
+- lib/sublayer/components/output_adapters/string_selection_from_list.rb
 - lib/sublayer/generators/base.rb
 - lib/sublayer/generators/examples/code_from_blueprint_generator.rb
 - lib/sublayer/generators/examples/code_from_description_generator.rb
 - lib/sublayer/generators/examples/description_from_code_generator.rb
 - lib/sublayer/generators/examples/invalid_to_valid_json_generator.rb
+- lib/sublayer/generators/examples/route_selection_from_user_intent_generator.rb
+- lib/sublayer/generators/examples/sentiment_from_text_generator.rb
 - lib/sublayer/providers/claude.rb
 - lib/sublayer/providers/gemini.rb
-- lib/sublayer/providers/groq.rb
-- lib/sublayer/providers/local.rb
 - lib/sublayer/providers/open_ai.rb
 - lib/sublayer/tasks/base.rb
 - lib/sublayer/version.rb
@@ -212,9 +213,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.26
 signing_key:

data/lib/sublayer/providers/groq.rb

@@ -1,52 +0,0 @@
-# Sublayer.configuration.ai_provider = Sublayer::Providers::Groq
-# Sublayer.configuration.ai_model = "mixtral-8x7b-32768"
-
-module Sublayer
-  module Providers
-    class Groq
-      def self.call(prompt:, output_adapter:)
-        system_prompt = <<-PROMPT
-        You have access to a set of tools to answer the prompt.
-
-        You may call tools like this:
-        <tool_calls>
-          <tool_call>
-            <tool_name>$TOOL_NAME</tool_name>
-            <parameters>
-              <#{output_adapter.name}>$VALUE</#{output_adapter.name}>
-              ...
-            </parameters>
-          </tool_call>
-        </tool_calls>
-
-        Here are the tools available:
-        <tools>
-          #{output_adapter.to_xml}
-        </tools>
-
-        Respond only with valid xml.
-        The entire response should be wrapped in a <response> tag.
-        Your response should call a tool inside a <tool_calls> tag.
-        PROMPT
-
-        response = HTTParty.post(
-          "https://api.groq.com/openai/v1/chat/completions",
-          headers: {
-            "Authorization": "Bearer #{ENV["GROQ_API_KEY"]}",
-            "Content-Type": "application/json"
-          },
-          body: {
-            "messages": [{"role": "user", "content": "#{system_prompt}\n#{prompt}"}],
-            "model": Sublayer.configuration.ai_model
-          }.to_json
-        )
-
-        text_containing_xml = response.dig("choices", 0, "message", "content")
-        tool_output = Nokogiri::HTML.parse(text_containing_xml.match(/\<#{output_adapter.name}\>(.*?)\<\/#{output_adapter.name}\>/m)[1]).text
-        raise "Groq did not format response correctly, error: #{response.body}" unless tool_output
-
-        return tool_output
-      end
-    end
-  end
-end

data/lib/sublayer/providers/local.rb

@@ -1,50 +0,0 @@
-# Sublayer.configuration.ai_provider = Sublayer::Providers::Local
-# Sublayer.configuration.ai_model = "LLaMA_CPP"
-
-module Sublayer
-  module Providers
-    class Local
-      def self.call(prompt:, output_adapter:)
-        system_prompt = <<-PROMPT
-        You have access to a set of tools to respond to the prompt.
-
-        You may call a tool with xml like this:
-        <parameters>
-          <#{output_adapter.name}>$VALUE</#{output_adapter.name}>
-          ...
-        </parameters>
-
-        Here are descriptions of the available tools:
-        <tools>
-          <tool>
-            #{output_adapter.to_xml}
-          </tool>
-        </tools>
-
-        Respond only with valid xml.
-        Your response should call a tool with xml inside a <parameters> tag.
-        PROMPT
-
-        response = HTTParty.post(
-          "http://localhost:8080/v1/chat/completions",
-          headers: {
-            "Authorization": "Bearer no-key",
-            "Content-Type": "application/json"
-          },
-          body: {
-            "model": Sublayer.configuration.ai_model,
-            "messages": [
-              { "role": "user", "content": "#{system_prompt}\n#{prompt}}" }
-            ]
-          }.to_json
-        )
-
-        text_containing_xml = response.dig("choices", 0, "message", "content")
-        tool_output = Nokogiri::HTML.parse(text_containing_xml.match(/\<#{output_adapter.name}\>(.*?)\<\/#{output_adapter.name}\>/m)[1]).text
-        raise "The response was not formatted correctly: #{response.body}" unless tool_output
-
-        return tool_output
-      end
-    end
-  end
-end