Module: RubyLLM

Defined in:

lib/ruby_llm.rb,
lib/ruby_llm/chat.rb,
lib/ruby_llm/cost.rb,
lib/ruby_llm/tool.rb,
lib/ruby_llm/agent.rb,
lib/ruby_llm/chunk.rb,
lib/ruby_llm/error.rb,
lib/ruby_llm/image.rb,
lib/ruby_llm/model.rb,
lib/ruby_llm/utils.rb,
lib/ruby_llm/models.rb,
lib/ruby_llm/tokens.rb,
lib/ruby_llm/aliases.rb,
lib/ruby_llm/content.rb,
lib/ruby_llm/context.rb,
lib/ruby_llm/message.rb,
lib/ruby_llm/railtie.rb,
lib/ruby_llm/version.rb,
lib/ruby_llm/provider.rb,
lib/ruby_llm/thinking.rb,
lib/ruby_llm/embedding.rb,
lib/ruby_llm/mime_type.rb,
lib/ruby_llm/streaming.rb,
lib/ruby_llm/tool_call.rb,
lib/ruby_llm/attachment.rb,
lib/ruby_llm/connection.rb,
lib/ruby_llm/model/info.rb,
lib/ruby_llm/moderation.rb,
lib/ruby_llm/configuration.rb,
lib/ruby_llm/model/pricing.rb,
lib/ruby_llm/providers/xai.rb,
lib/ruby_llm/transcription.rb,
lib/ruby_llm/providers/azure.rb,
lib/ruby_llm/model/modalities.rb,
lib/ruby_llm/providers/gemini.rb,
lib/ruby_llm/providers/ollama.rb,
lib/ruby_llm/providers/openai.rb,
lib/ruby_llm/providers/bedrock.rb,
lib/ruby_llm/providers/mistral.rb,
lib/ruby_llm/model/pricing_tier.rb,
lib/ruby_llm/providers/deepseek.rb,
lib/ruby_llm/providers/gpustack.rb,
lib/ruby_llm/providers/vertexai.rb,
lib/ruby_llm/providers/xai/chat.rb,
lib/ruby_llm/stream_accumulator.rb,
lib/ruby_llm/providers/anthropic.rb,
lib/ruby_llm/providers/azure/chat.rb,
lib/ruby_llm/providers/openrouter.rb,
lib/ruby_llm/providers/perplexity.rb,
lib/ruby_llm/providers/xai/models.rb,
lib/ruby_llm/active_record/acts_as.rb,
lib/ruby_llm/providers/azure/media.rb,
lib/ruby_llm/providers/gemini/chat.rb,
lib/ruby_llm/providers/ollama/chat.rb,
lib/ruby_llm/providers/openai/chat.rb,
lib/ruby_llm/model/pricing_category.rb,
lib/ruby_llm/providers/azure/models.rb,
lib/ruby_llm/providers/bedrock/auth.rb,
lib/ruby_llm/providers/bedrock/chat.rb,
lib/ruby_llm/providers/gemini/media.rb,
lib/ruby_llm/providers/gemini/tools.rb,
lib/ruby_llm/providers/mistral/chat.rb,
lib/ruby_llm/providers/ollama/media.rb,
lib/ruby_llm/providers/openai/media.rb,
lib/ruby_llm/providers/openai/tools.rb,
lib/ruby_llm/providers/bedrock/media.rb,
lib/ruby_llm/providers/deepseek/chat.rb,
lib/ruby_llm/providers/gemini/images.rb,
lib/ruby_llm/providers/gemini/models.rb,
lib/ruby_llm/providers/gpustack/chat.rb,
lib/ruby_llm/providers/ollama/models.rb,
lib/ruby_llm/providers/openai/images.rb,
lib/ruby_llm/providers/openai/models.rb,
lib/ruby_llm/providers/vertexai/chat.rb,
lib/ruby_llm/providers/anthropic/chat.rb,
lib/ruby_llm/providers/bedrock/models.rb,
lib/ruby_llm/providers/gpustack/media.rb,
lib/ruby_llm/providers/mistral/models.rb,
lib/ruby_llm/providers/anthropic/media.rb,
lib/ruby_llm/providers/anthropic/tools.rb,
lib/ruby_llm/providers/gpustack/models.rb,
lib/ruby_llm/providers/openrouter/chat.rb,
lib/ruby_llm/providers/perplexity/chat.rb,
lib/ruby_llm/providers/vertexai/models.rb,
lib/ruby_llm/active_record/chat_methods.rb,
lib/ruby_llm/providers/anthropic/models.rb,
lib/ruby_llm/providers/azure/embeddings.rb,
lib/ruby_llm/providers/gemini/streaming.rb,
lib/ruby_llm/providers/openai/streaming.rb,
lib/ruby_llm/active_record/model_methods.rb,
lib/ruby_llm/providers/anthropic/content.rb,
lib/ruby_llm/providers/bedrock/streaming.rb,
lib/ruby_llm/providers/gemini/embeddings.rb,
lib/ruby_llm/providers/openai/embeddings.rb,
lib/ruby_llm/providers/openai/moderation.rb,
lib/ruby_llm/providers/openrouter/images.rb,
lib/ruby_llm/providers/openrouter/models.rb,
lib/ruby_llm/providers/perplexity/models.rb,
lib/generators/ruby_llm/generator_helpers.rb,
lib/ruby_llm/active_record/acts_as_legacy.rb,
lib/ruby_llm/providers/mistral/embeddings.rb,
lib/ruby_llm/providers/openai/temperature.rb,
lib/ruby_llm/providers/vertexai/streaming.rb,
lib/ruby_llm/active_record/message_methods.rb,
lib/ruby_llm/active_record/payload_helpers.rb,
lib/ruby_llm/providers/anthropic/streaming.rb,
lib/ruby_llm/providers/gemini/capabilities.rb,
lib/ruby_llm/providers/ollama/capabilities.rb,
lib/ruby_llm/providers/openai/capabilities.rb,
lib/ruby_llm/providers/vertexai/embeddings.rb,
lib/generators/ruby_llm/tool/tool_generator.rb,
lib/ruby_llm/providers/anthropic/embeddings.rb,
lib/ruby_llm/providers/gemini/transcription.rb,
lib/ruby_llm/providers/mistral/capabilities.rb,
lib/ruby_llm/providers/openai/transcription.rb,
lib/ruby_llm/providers/openrouter/streaming.rb,
lib/ruby_llm/active_record/tool_call_methods.rb,
lib/ruby_llm/providers/deepseek/capabilities.rb,
lib/ruby_llm/providers/gpustack/capabilities.rb,
lib/generators/ruby_llm/agent/agent_generator.rb,
lib/ruby_llm/providers/anthropic/capabilities.rb,
lib/ruby_llm/providers/vertexai/transcription.rb,
lib/ruby_llm/providers/perplexity/capabilities.rb,
lib/generators/ruby_llm/schema/schema_generator.rb,
lib/generators/ruby_llm/chat_ui/chat_ui_generator.rb,
lib/generators/ruby_llm/install/install_generator.rb,
lib/generators/ruby_llm/upgrade_to_v1_7/upgrade_to_v1_7_generator.rb,
lib/generators/ruby_llm/upgrade_to_v1_9/upgrade_to_v1_9_generator.rb,
lib/generators/ruby_llm/upgrade_to_v1_10/upgrade_to_v1_10_generator.rb,
lib/generators/ruby_llm/upgrade_to_v1_14/upgrade_to_v1_14_generator.rb

Overview

A delightful Ruby interface to modern AI language models.

Defined Under Namespace

Modules: ActiveRecord, Generators, MimeType, Model, Providers, Streaming, Utils Classes: Agent, Aliases, Attachment, BadRequestError, Chat, Chunk, Configuration, ConfigurationError, Connection, Content, Context, ContextLengthExceededError, Cost, Embedding, Error, ErrorMiddleware, ForbiddenError, Image, InvalidRoleError, InvalidToolChoiceError, Message, ModelNotFoundError, Models, Moderation, OverloadedError, Parameter, PaymentRequiredError, PromptNotFoundError, Provider, Railtie, RateLimitError, ServerError, ServiceUnavailableError, StreamAccumulator, Thinking, Tokens, Tool, ToolCall, Transcription, UnauthorizedError, UnsupportedAttachmentError

Constant Summary

VERSION =

'1.15.0'

Class Method Summary

• .chat ⇒ Object
• .config ⇒ Object
• .configure {|config| ... } ⇒ Object
• .context {|context_config| ... } ⇒ Object
• .embed ⇒ Object
• .logger ⇒ Object
• .models ⇒ Object
• .moderate ⇒ Object
• .paint ⇒ Object
• .providers ⇒ Object
• .transcribe ⇒ Object

Class Method Details

.chat ⇒ Object

# File 'lib/ruby_llm.rb', line 51

def chat(...)
  Chat.new(...)
end

.config ⇒ Object

# File 'lib/ruby_llm.rb', line 83

def config
  @config ||= Configuration.new
end

.configure {|config| ... } ⇒ Object

Yields:

• (config)

# File 'lib/ruby_llm.rb', line 79

def configure
  yield config
end

.context {|context_config| ... } ⇒ Object

Yields:

• (context_config)

# File 'lib/ruby_llm.rb', line 45

def context
  context_config = config.dup
  yield context_config if block_given?
  Context.new(context_config)
end

.embed ⇒ Object

# File 'lib/ruby_llm.rb', line 55

def embed(...)
  Embedding.embed(...)
end

.logger ⇒ Object

# File 'lib/ruby_llm.rb', line 87

def logger
  @logger ||= config.logger || Logger.new(
    config.log_file,
    progname: 'RubyLLM',
    level: config.log_level
  )
end

.models ⇒ Object

# File 'lib/ruby_llm.rb', line 71

def models
  Models.instance
end

.moderate ⇒ Object

# File 'lib/ruby_llm.rb', line 59

def moderate(...)
  Moderation.moderate(...)
end

.paint ⇒ Object

# File 'lib/ruby_llm.rb', line 63

def paint(...)
  Image.paint(...)
end

.providers ⇒ Object

# File 'lib/ruby_llm.rb', line 75

def providers
  Provider.providers.values
end

.transcribe ⇒ Object

# File 'lib/ruby_llm.rb', line 67

def transcribe(...)
  Transcription.transcribe(...)
end