Skip to content

index.md

Latest commit

 

History

History
177 lines (142 loc) · 7.44 KB

index.md

File metadata and controls

177 lines (142 loc) · 7.44 KB
layout default
title Home
nav_order 1
description RubyLLM is a delightful Ruby way to work with AI.
permalink /
RubyLLM <iframe src="https://ghbtns.com/github-btn.html?user=crmne&repo=ruby_llm&type=star&count=true&size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub" style="vertical-align: middle; display: inline-block;"></iframe>

One beautiful API for ChatGPT, Claude, Gemini, and more. Chat, images, embeddings, tools. {: .fs-6 .fw-300 }

Get started GitHub

Anthropic
Bedrock Bedrock
DeepSeek DeepSeek
Gemini
GPUStack
Ollama Ollama
OpenAI OpenAI
OpenRouter OpenRouter
Gem Version Ruby Style Guide Gem Downloads codecov

🤺 Battle tested at 💬 Chat with Work

The problem with AI libraries

Every AI provider comes with its own client library, its own response format, its own conventions for streaming, and its own way of handling errors. Want to use multiple providers? Prepare to juggle incompatible APIs and bloated dependencies.

RubyLLM fixes all that. One beautiful API for everything. One consistent format. Minimal dependencies — just Faraday, Zeitwerk, and Marcel. Because working with AI should be a joy, not a chore.

What makes it great

# Just ask questions
chat = RubyLLM.chat
chat.ask "What's the best way to learn Ruby?"

# Analyze images, audio, documents, and text files
chat.ask "What's in this image?", with: "ruby_conf.jpg"
chat.ask "Describe this meeting", with: "meeting.wav"
chat.ask "Summarize this document", with: "contract.pdf"
chat.ask "Explain this code", with: "app.rb"

# Multiple files at once - types automatically detected
chat.ask "Analyze these files", with: ["diagram.png", "report.pdf", "notes.txt"]

# Stream responses in real-time
chat.ask "Tell me a story about a Ruby programmer" do |chunk|
  print chunk.content
end

# Generate images
RubyLLM.paint "a sunset over mountains in watercolor style"

# Create vector embeddings
RubyLLM.embed "Ruby is elegant and expressive"

# Let AI use your code
class Weather < RubyLLM::Tool
  description "Gets current weather for a location"
  param :latitude, desc: "Latitude (e.g., 52.5200)"
  param :longitude, desc: "Longitude (e.g., 13.4050)"

  def execute(latitude:, longitude:)
    url = "https://api.open-meteo.com/v1/forecast?latitude=#{latitude}&longitude=#{longitude}&current=temperature_2m,wind_speed_10m"

    response = Faraday.get(url)
    data = JSON.parse(response.body)
  rescue => e
    { error: e.message }
  end
end

chat.with_tool(Weather).ask "What's the weather in Berlin? (52.5200, 13.4050)"

Core Capabilities

  • 💬 Unified Chat: Converse with models from OpenAI, Anthropic, Gemini, Bedrock, OpenRouter, DeepSeek, Ollama, or any OpenAI-compatible API using RubyLLM.chat.
  • 👁️ Vision: Analyze images within chats.
  • 🔊 Audio: Transcribe and understand audio content.
  • 📄 Document Analysis: Extract information from PDFs, text files, and other documents.
  • 🖼️ Image Generation: Create images with RubyLLM.paint.
  • 📊 Embeddings: Generate text embeddings for vector search with RubyLLM.embed.
  • 🔧 Tools (Function Calling): Let AI models call your Ruby code using RubyLLM::Tool.
  • 🚂 Rails Integration: Easily persist chats, messages, and tool calls using acts_as_chat and acts_as_message.
  • 🌊 Streaming: Process responses in real-time with idiomatic Ruby blocks.

Installation

Add to your Gemfile:

gem 'ruby_llm'

Then bundle install.

Configure your API keys (using environment variables is recommended):

# config/initializers/ruby_llm.rb or similar
RubyLLM.configure do |config|
  config.openai_api_key = ENV.fetch('OPENAI_API_KEY', nil)
  # Add keys ONLY for providers you intend to use
  # config.anthropic_api_key = ENV.fetch('ANTHROPIC_API_KEY', nil)
  # ... see Configuration guide for all options ...
end

See the Installation Guide for full details.

Rails Integration

Add persistence to your chat models effortlessly:

# Generate models and migrations (available in v1.4.0)
rails generate ruby_llm:install
# Or add to existing models
class Chat < ApplicationRecord
  acts_as_chat # Automatically saves messages & tool calls
end

class Message < ApplicationRecord
  acts_as_message
end

class ToolCall < ApplicationRecord
  acts_as_tool_call
end

# Now chats persist automatically
chat = Chat.create!(model_id: "gpt-4.1-nano")
chat.ask("What's in this file?", with: "report.pdf")

See the Rails Integration Guide for details.