Merge branch 'crmne:main' into main

Author: bricolage

.overcommit.yml

@@ -24,10 +24,10 @@ PreCommit:
     targets: ['models:update', 'models:docs', 'aliases:generate']
     on_warn: fail
 
-  AppraisalGenerate:
+  AppraisalUpdate:
     enabled: true
-    description: 'Generate appraisal gemfiles'
-    command: ['bundle', 'exec', 'appraisal', 'generate']
+    description: 'Update appraisal gemfiles'
+    command: ['bundle', 'exec', 'appraisal', 'update']
 
 PostCheckout:
   ALL: # Special hook name that customizes all hooks of this type

.rubocop.yml

@@ -1,4 +1,5 @@
 plugins:
+  - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
 
@@ -21,7 +22,18 @@ Metrics/MethodLength:
   Enabled: false
 Metrics/ModuleLength:
   Enabled: false
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - spec/**/*
+Performance/RedundantBlockCall:
+  Enabled: false # TODO: temporarily disabled to avoid potential breaking change
+Performance/StringInclude:
+  Exclude:
+    - lib/ruby_llm/providers/**/capabilities.rb
+Performance/UnfreezeString:
+  Exclude:
+    - spec/**/*
 RSpec/ExampleLength:
   Enabled: false
 RSpec/MultipleExpectations:
-  Enabled: false
+  Enabled: false

Gemfile

@@ -22,6 +22,7 @@ group :development do # rubocop:disable Metrics/BlockLength
   gem 'reline'
   gem 'rspec', '~> 3.12'
   gem 'rubocop', '>= 1.0'
+  gem 'rubocop-performance'
   gem 'rubocop-rake', '>= 0.6'
   gem 'rubocop-rspec'
   gem 'ruby_llm-schema', '~> 0.1.0'

README.md

@@ -1,44 +1,18 @@
-<img src="/docs/assets/images/logotype.svg" alt="RubyLLM" height="120" width="250">
-
-**A delightful Ruby way to work with AI.** RubyLLM provides **one** beautiful, Ruby-like interface to interact with modern AI models. Chat, generate images, create embeddings, and use tools – all with clean, expressive code that feels like Ruby, not like patching together multiple services.
-
-<div class="provider-icons">
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/anthropic-text.svg" alt="Anthropic" class="logo-small">
-  &nbsp;
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/bedrock-color.svg" alt="Bedrock" class="logo-medium">
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/bedrock-text.svg" alt="Bedrock" class="logo-small">
-  &nbsp;
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/deepseek-color.svg" alt="DeepSeek" class="logo-medium">
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/deepseek-text.svg" alt="DeepSeek" class="logo-small">
-  &nbsp;
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/gemini-brand-color.svg" alt="Gemini" class="logo-large">
-  <br>
-  <img src="https://raw.githubusercontent.com/gpustack/gpustack/main/docs/assets/gpustack-logo.png" alt="GPUStack" class="logo-medium" height="16">
-  &nbsp;
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/mistral-color.svg" alt="Mistral" class="logo-medium">
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/mistral-text.svg" alt="Mistral" class="logo-small">
-  &nbsp;
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/ollama.svg" alt="Ollama" class="logo-medium">
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/ollama-text.svg" alt="Ollama" class="logo-medium">
-  &nbsp;
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/openai.svg" alt="OpenAI" class="logo-medium">
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/openai-text.svg" alt="OpenAI" class="logo-medium">
-  &nbsp;
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/openrouter.svg" alt="OpenRouter" class="logo-medium">
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/openrouter-text.svg" alt="OpenRouter" class="logo-small">
-  &nbsp;
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/perplexity-color.svg" alt="Perplexity" class="logo-medium">
-  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/perplexity-text.svg" alt="Perplexity" class="logo-small">
-</div>
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="/docs/assets/images/logotype_dark.svg">
+  <img src="/docs/assets/images/logotype.svg" alt="RubyLLM" height="120" width="250">
+</picture>
+
+**One *beautiful* Ruby API for GPT, Claude, Gemini, and more.** Easily build chatbots, AI agents, RAG applications, and content generators. Features chat (text, images, audio, PDFs), image generation, embeddings, tools (function calling), structured output, Rails integration, and streaming. Works with OpenAI, Anthropic, Google Gemini, AWS Bedrock, DeepSeek, Mistral, Ollama (local models), OpenRouter, Perplexity, GPUStack, and any OpenAI-compatible API.
 
 <div class="badge-container">
-  <a href="https://badge.fury.io/rb/ruby_llm"><img src="https://badge.fury.io/rb/ruby_llm.svg?a=3" alt="Gem Version" /></a>
+  <a href="https://badge.fury.io/rb/ruby_llm"><img src="https://badge.fury.io/rb/ruby_llm.svg?a=5" alt="Gem Version" /></a>
   <a href="https://github.com/testdouble/standard"><img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Ruby Style Guide" /></a>
   <a href="https://rubygems.org/gems/ruby_llm"><img alt="Gem Downloads" src="https://img.shields.io/gem/dt/ruby_llm"></a>
   <a href="https://codecov.io/gh/crmne/ruby_llm"><img src="https://codecov.io/gh/crmne/ruby_llm/branch/main/graph/badge.svg" alt="codecov" /></a>
 </div>
 
-🤺 Battle tested at [💬 Chat with Work](https://chatwithwork.com)
+Battle tested at [<picture><source media="(prefers-color-scheme: dark)" srcset="https://chatwithwork.com/logotype-dark.svg"><img src="https://chatwithwork.com/logotype.svg" alt="Chat with Work" height="30" align="absmiddle"></picture>](https://chatwithwork.com) — *Claude Code for your documents*
 
 ## The problem with AI libraries
 

docs/_advanced/error-handling.md

@@ -50,7 +50,6 @@ RubyLLM::Error                    # Base error class for API/network issues
 RubyLLM::ConfigurationError   # Missing required configuration (e.g., API key)
 RubyLLM::ModelNotFoundError   # Requested model ID not found in registry
 RubyLLM::InvalidRoleError     # Invalid role symbol used for a message
-RubyLLM::UnsupportedFunctionsError # Tried to use tools with an unsupported model
 ```
 
 ## Basic Error Handling

docs/_advanced/models.md

@@ -260,7 +260,7 @@ puts response.content
 
 # You can also use it in .with_model
 chat.with_model(
-  model: 'gpt-5-alpha',
+  'gpt-5-alpha',
   provider: :openai,                # MUST specify provider
   assume_exists: true
 )

docs/_config.yml

@@ -83,8 +83,6 @@ nav_external_links:
     url: https://paolino.me
     hide_icon: false
 
-footer_content: "Open source under <a href=\"https://github.com/crmne/ruby_llm/tree/main/LICENSE\">MIT license</a>.<br>Built by <a href=\"https://paolino.me\">Carmine Paolino</a>, maker of <a href=\"https://chatwithwork.com\"><strong>Chat with Work</strong></a> — Claude Code for your documents."
-
 last_edit_timestamp: true
 
 enable_copy_code_button: true

docs/_core_features/chat.md

@@ -424,17 +424,16 @@ Not all models support structured output. Currently supported:
 - **Anthropic**: No native structured output support. You can simulate it with tool definitions or careful prompting
 - **Gemini**: Gemini 1.5 Pro/Flash and newer
 
-Models that don't support structured output will raise an error:
+Models that don't support structured output:
 
 ```ruby
+# RubyLLM 1.6.2+ will attempt to use schemas with any model
 chat = RubyLLM.chat(model: 'gpt-3.5-turbo')
-chat.with_schema(schema) # Raises UnsupportedStructuredOutputError
-```
-
-You can force schema usage even if the model registry says it's unsupported:
+chat.with_schema(schema)
+response = chat.ask('Generate a person')
+# Provider will return an error if unsupported
 
-```ruby
-chat.with_schema(schema, force: true)
+# Prior to 1.6.2, with_schema would raise UnsupportedStructuredOutputError
 ```
 
 ### Multi-turn Conversations with Schemas

docs/_core_features/tools.md

@@ -204,14 +204,27 @@ weather_tool = Weather.new
 chat.with_tool(weather_tool)
 # Or add multiple: chat.with_tools(WeatherLookup, AnotherTool.new)
 
+# Replace all tools with new ones
+chat.with_tools(NewTool, AnotherTool, replace: true)
+
+# Clear all tools
+chat.with_tools(replace: true)
+
 # Ask a question that should trigger the tool
 response = chat.ask "What's the current weather like in Berlin? (Lat: 52.52, Long: 13.40)"
 puts response.content
 # => "Current weather at 52.52, 13.4: Temperature: 12.5°C, Wind Speed: 8.3 km/h, Conditions: Mainly clear, partly cloudy, and overcast."
 ```
 
-> Ensure the model you select supports function calling/tools. Check model capabilities using `RubyLLM.models.find('your-model-id').supports_functions?`. Attempting to use `with_tool` on an unsupported model will raise `RubyLLM::UnsupportedFunctionsError`.
-{: .warning }
+### Model Compatibility
+{: .d-inline-block }
+
+Changed in v1.6.2+
+{: .label .label-green }
+
+RubyLLM v1.6.2+ will attempt to use tools with any model. If the model doesn't support function calling, the provider will return an appropriate error when you call `ask`.
+
+Prior to v1.6.2, calling `with_tool` on an unsupported model would immediately raise `RubyLLM::UnsupportedFunctionsError`.
 
 ## The Tool Execution Flow
 

docs/_getting_started/configuration.md

@@ -98,7 +98,7 @@ Connect to any OpenAI-compatible API endpoint, including local models, proxies,
 RubyLLM.configure do |config|
   # API key - use what your server expects
   config.openai_api_key = ENV['CUSTOM_API_KEY']  # Or 'dummy-key' if not required
-  
+
   # Your custom endpoint
   config.openai_api_base = "http://localhost:8080/v1"  # vLLM, LiteLLM, etc.
 end
@@ -119,7 +119,7 @@ OpenAI's API now uses 'developer' role for system messages, but some OpenAI-comp
 RubyLLM.configure do |config|
   # For servers that require 'system' role (e.g., older vLLM, some local models)
   config.openai_use_system_role = true  # Use 'system' role instead of 'developer'
-  
+
   # Your OpenAI-compatible endpoint
   config.openai_api_base = "http://localhost:11434/v1"  # Ollama, vLLM, etc.
   config.openai_api_key = "dummy-key"  # If required by your server
@@ -222,9 +222,6 @@ RubyLLM.configure do |config|
   # Enable debug logging via environment variable
   config.log_level = :debug if ENV['RUBYLLM_DEBUG'] == 'true'
 
-  # Silence "Assuming model exists" warnings
-  config.log_assume_model_exists = false
-
   # Show detailed streaming chunks (v1.6.0+)
   config.log_stream_debug = true  # Or set RUBYLLM_STREAM_DEBUG=true
 end
@@ -356,7 +353,6 @@ RubyLLM.configure do |config|
   config.logger = Logger
   config.log_file = String
   config.log_level = Symbol
-  config.log_assume_model_exists = Boolean
   config.log_stream_debug = Boolean  # v1.6.0+
 end
 ```