API Reference
RDoc documentation for every public RubyLLM class and method
The API reference opens on the RubyLLM module, with the framework’s entry points and examples. Each class and method documents its arguments, return value, and behavior.
| Build with | Reference |
|---|---|
| Conversations and structured responses | Chat, Message |
| Tools and agents | Tool, Agent |
| Images, video, and speech | Image, Video, Speech |
| Transcription, OCR, and moderation | Transcription, OCR, Moderation |
| Search and retrieval | Embedding, Rerank |
| Rails records | ActiveRecord::ActsAs |
| Models and configuration | Models, Configuration, Context |
| Usage and background processing | Tokens, Cost, Batch |
For Markdown, start with RubyLLM.md or the class index. Every HTML class page has a matching .md page.
The reference is generated from source comments with RDoc. Build it locally with bundle exec rake rdoc.