API Reference
The full RDoc documentation for every public class and method in this version of RubyLLM.
Browse the API docs Browse as Markdown
These guides show you how to build things. The API reference tells you exactly what each class and method does: signatures, return values, and examples, in the style of Ruby’s own documentation. Good entry points:
- RubyLLM (Markdown), the module-level entry points
- Chat (Markdown), conversations and the agentic loop
- Tool (Markdown), giving models abilities
- Agent (Markdown), reusable configured chats
- ActiveRecord::ActsAs (Markdown), the Rails macros
- Models (Markdown), the model registry
- Configuration (Markdown), every setting
The API reference is generated from the source with RDoc. Build it locally with rake rdoc.