Sublayer

A model-agnostic Ruby AI Agent framework. Provides base classes for building Generators, Actions, Tasks, and Agents that can be used to build AI powered applications in Ruby.

For more detailed documentation visit our documentation site: https://docs.sublayer.com.

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.2.x, you would add the following line to your Gemfile:

gem 'sublayer', '~> 0.2'

New default model update: gpt 4 turbo -> gpt 4o

Gemini: Updates include the use of beta API function calling features. Experimental and unstable.

Install the gem by running the following commands:

$ gem install sublayer

Or add this line to your application's Gemfile:

gem 'sublayer', '~> 0.2'

Sublayer is model-agnostic and can be used with any AI model. Below are the supported LLM Providers. Check out our docs to add your own custom Provider.

Expects you to have an OpenAI API key set in the OPENAI_API_KEY environment variable.

Visit OpenAI to get an API key.

Usage:

Sublayer.configuration.ai_provider = Sublayer::Providers::OpenAI
Sublayer.configuration.ai_model = "gpt-4o"

(Gemini's function calling API is in beta. Not recommended for production use.)

Expects you to have a Gemini API key set in the GEMINI_API_KEY environment variable.

Visit Google AI Studio to get an API key.

Usage:

Sublayer.configuration.ai_provider = Sublayer::Providers::Gemini
Sublayer.configuration.ai_model = "gemini-1.5-pro"

Expect you to have a Claude API key set in the ANTHROPIC_API_KEY environment variable.

Visit Anthropic to get an API key.

Usage:

Sublayer.configuration.ai_provider = Sublayer::Providers::Claude
Sublayer.configuration.ai_model ="claude-3-5-sonnet-20240620"

Generators are responsible for generating specific outputs based on input data. They focus on a single generation task and do not perform any actions or complex decision-making. Generators are the building blocks of the Sublayer framework.

Examples (in the /spec/generators/examples directory):

• CodeFromDescriptionGenerator: Generates code based on a description and the technologies used.
• DescriptionFromCodeGenerator: Generates a description of the code passed in to it.
• CodeFromBlueprintGenerator: Generates code based on a blueprint, a blueprint description, and a description of the desired code.

Actions perform specific operations to either get inputs for a Generator or use the generated output from a Generator. Actions do not involve complex decision making.

Examples:

• WriteFileAction: Saves generated output to a file.
• RunTestCommandAction: Runs a generated command line command.

Sublayer Agents are autonomous entities designed to perform specific tasks or monitor systems.

Examples:

• RSpecAgent: Runs tests whenever a file is changed. If the tests fail the code is changed by the agent to pass the tests.

Sublayer Triggers are used in agents. Triggers decide when an agent is activated and performs its task

Examples:

• FileChange: This built in sublayer trigger, listens for file changes
• TimeInterval This custom trigger tutorial shows how to create your own trigger, this one activates on a time interval

There are sample Generators in the /examples/ directory that demonstrate how to build generators using the Sublayer framework. Alternatively below are links to open source projects that are using generators in different ways:

• Blueprints - An open source AI code assistant that allows you to capture patterns in your codebase to use as a base for generating new code.

• Clag - A ruby gem that generates command line commands from a simple description right in your terminal.