Quick Start

Quasi sapiente voluptates aut minima non doloribus similique quisquam. In quo expedita ipsum nostrum corrupti incidunt. Et aut eligendi ea perferendis.

Requirements

This gem is developed on Ruby 3.2.

Et pariatur ab quas

Sit commodi iste iure molestias qui amet voluptatem sed quaerat. Nostrum aut pariatur. Sint ipsa praesentium dolor error cumque velit tenetur quaerat exercitationem. Consequatur et cum atque mollitia qui quia necessitatibus.

/** @type {import('@tailwindlabs/lorem').ipsum} */
export default {
  lorem: 'ipsum',
  dolor: ['sit', 'amet', 'consectetur'],
  adipiscing: {
    elit: true,
  },
}

Possimus saepe veritatis sint nobis et quam eos. Architecto consequatur odit perferendis fuga eveniet possimus rerum cumque. Ea deleniti voluptatum deserunt voluptatibus ut non iste. Provident nam asperiores vel laboriosam omnis ducimus enim nesciunt quaerat. Minus tempora cupiditate est quod.

Natus aspernatur iste

Voluptas beatae omnis omnis voluptas. Cum architecto ab sit ad eaque quas quia distinctio. Molestiae aperiam qui quis deleniti soluta quia qui. Dolores nostrum blanditiis libero optio id. Mollitia ad et asperiores quas saepe alias.

Installation

In your Gemfile:

gem "roseflow"

And then

bundle install

Configuring Roseflow

Roseflow works in symbiosis with AI models. You need to configure Roseflow to use models from an AI provider, or integrate to your own ML infrastructure.

OpenAI

To access supported OpenAI models, configure your OpenAI credentials to Roseflow.

To configure a provider for Roseflow, define a configuration block like this somewhere in your application or library initialization code.

Roseflow.configure do |config|
  config.provider :openai,
    api_key: "<YOUR_OPENAI_API_KEY>"
end

If you are using Roseflow with Rails, you can do it in the Roseflow initializer. We recommend storing the API key in the Rails credentials vault.

# ./config/initializers/roseflow.rb

Roseflow.configure do |config|
  config.provider :openai,
    api_key: Rails.application.credentials.dig(:openai, :api_key)
end

Bring Your Own AI

There are two ways of integrating Roseflow into your own AI/ML infrastructure.

Registering inference endpoints in a custom provider, if your AI/ML infrastructure supports making inference over HTTP
Writing your custom integration logic to your own custom provider

Using Roseflow with Rails

If you are using Roseflow with Rails, you should use the roseflow-rails gem. Add it to the Gemfile of your Rails application.

When you run bundle install, Bundler will install the core library and the Roseflow on Rails engine.

Setup

After Bundler, you should run the Roseflow installer.

rake roseflow:install

The installer will guide you through getting Roseflow set up and configured for your Rails app.

Configuring

Configure providers you wish to use with Roseflow. The installer will create an initializer for you to hold the configuration. We recommend storing any API keys in the Rails credentials vault.

# ./config/initializers/roseflow.rb

Roseflow.configure do |config|
  config.provider :openai,
    api_key: Rails.application.credentials.dig(:openai, :api_key)
end