RubyLLM Guides

This section contains detailed guides to help you make the most of RubyLLM. Each guide focuses on a specific aspect of the library and provides practical examples and best practices.

Available Guides

Getting Started

Learn the basics of RubyLLM and get up and running quickly with simple examples.

Chat

Explore the chat interface, which is the primary way to interact with AI models through RubyLLM.

Tools

Learn how to extend AI capabilities by creating tools that let models call your Ruby code.

Streaming

Understand how to use streaming responses for real-time interactions.

Rails Integration

See how to integrate RubyLLM with Rails applications, including ActiveRecord persistence.

Image Generation

Learn how to generate images using DALL-E and other providers.

Embeddings

Explore how to create vector embeddings for semantic search and other applications.

Error Handling

Master the techniques for robust error handling in AI applications.

Getting Help

If you can’t find what you’re looking for in these guides, consider:

  1. Checking the API Documentation for detailed information about specific classes and methods
  2. Looking at the GitHub repository for examples and the latest updates
  3. Filing an issue on GitHub if you find a bug or have a feature request

Table of contents