Fix zeitwerk error when eager_load is turned on (#822)

* Fix zeitwerk error when eager_load is turned on
* Rename /assistants directory to /assistant
* Move Langchain::Messages namespace to Langchain::Assistant::Messages
* Clean up zeitwerk configuration
* Add code comments

* fixes

Author: andreibondarev

CHANGELOG.md

@@ -1,4 +1,5 @@
 ## [Unreleased]
+- [BREAKING] `Langchain::Messages::*` namespace had migrated to `Langchain::Assistant::Messages::*`
 - [BREAKING] Modify `Langchain::LLM::AwsBedrock` constructor to pass model options via default_options: {...}
 - Added support for streaming with Anthropic
 - Bump anthropic gem

examples/open_ai_qdrant_function_calls.rb renamed to examples/openai_qdrant_function_calls.rb

@@ -22,25 +22,12 @@
   "mistral_ai_response" => "MistralAIResponse",
   "mistral_ai_message" => "MistralAIMessage",
   "openai" => "OpenAI",
-  "openai_validator" => "OpenAIValidator",
   "openai_response" => "OpenAIResponse",
   "openai_message" => "OpenAIMessage",
   "pdf" => "PDF"
 )
+
 loader.collapse("#{__dir__}/langchain/llm/response")
-loader.collapse("#{__dir__}/langchain/assistants")
-
-loader.collapse("#{__dir__}/langchain/tool/calculator")
-loader.collapse("#{__dir__}/langchain/tool/database")
-loader.collapse("#{__dir__}/langchain/tool/docs_tool")
-loader.collapse("#{__dir__}/langchain/tool/file_system")
-loader.collapse("#{__dir__}/langchain/tool/google_search")
-loader.collapse("#{__dir__}/langchain/tool/ruby_code_interpreter")
-loader.collapse("#{__dir__}/langchain/tool/news_retriever")
-loader.collapse("#{__dir__}/langchain/tool/tavily")
-loader.collapse("#{__dir__}/langchain/tool/vectorsearch")
-loader.collapse("#{__dir__}/langchain/tool/weather")
-loader.collapse("#{__dir__}/langchain/tool/wikipedia")
 
 # RubyCodeInterpreter does not work with Ruby 3.3;
 # https://github.com/ukutaht/safe_ruby/issues/4

lib/langchain.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "llm/adapter"
-
 module Langchain
   # Assistants are Agent-like objects that leverage helpful instructions, LLMs, tools and knowledge to respond to user queries.
   # Assistants can be configured with an LLM of your choice, any vector search database and easily extended with additional tools.
@@ -104,7 +102,7 @@ def prompt_of_concatenated_messages
     # @param messages [Array<Langchain::Message>] The messages to set
     # @return [Array<Langchain::Message>] The messages
     def messages=(messages)
-      raise ArgumentError, "messages array must only contain Langchain::Message instance(s)" unless messages.is_a?(Array) && messages.all? { |m| m.is_a?(Langchain::Messages::Base) }
+      raise ArgumentError, "messages array must only contain Langchain::Message instance(s)" unless messages.is_a?(Array) && messages.all? { |m| m.is_a?(Messages::Base) }
 
       @messages = messages
     end
@@ -336,15 +334,15 @@ def execute_tools
     def determine_tool_role
       case llm
       when Langchain::LLM::Anthropic
-        Langchain::Messages::AnthropicMessage::TOOL_ROLE
+        Messages::AnthropicMessage::TOOL_ROLE
       when Langchain::LLM::GoogleGemini, Langchain::LLM::GoogleVertexAI
-        Langchain::Messages::GoogleGeminiMessage::TOOL_ROLE
+        Messages::GoogleGeminiMessage::TOOL_ROLE
       when Langchain::LLM::MistralAI
-        Langchain::Messages::MistralAIMessage::TOOL_ROLE
+        Messages::MistralAIMessage::TOOL_ROLE
       when Langchain::LLM::Ollama
-        Langchain::Messages::OllamaMessage::TOOL_ROLE
+        Messages::OllamaMessage::TOOL_ROLE
       when Langchain::LLM::OpenAI
-        Langchain::Messages::OpenAIMessage::TOOL_ROLE
+        Messages::OpenAIMessage::TOOL_ROLE
       end
     end
 

lib/langchain/assistants/assistant.rb renamed to lib/langchain/assistant.rb

@@ -1,4 +1,4 @@
-Dir[Pathname.new(__FILE__).dirname.join("adapters", "*.rb")].sort.each { |file| require file }
+# frozen_string_literal: true
 
 module Langchain
   class Assistant

lib/langchain/assistants/llm/adapter.rb renamed to lib/langchain/assistant/llm/adapter.rb

@@ -1,8 +1,17 @@
+# frozen_string_literal: true
+
 module Langchain
   class Assistant
     module LLM
       module Adapters
         class Anthropic < Base
+          # Build the chat parameters for the Anthropic API
+          #
+          # @param tools [Array<Hash>] The tools to use
+          # @param instructions [String] The system instructions
+          # @param messages [Array<Hash>] The messages
+          # @param tool_choice [String] The tool choice
+          # @return [Hash] The chat parameters
           def build_chat_params(tools:, instructions:, messages:, tool_choice:)
             params = {messages: messages}
             if tools.any?
@@ -13,10 +22,18 @@ def build_chat_params(tools:, instructions:, messages:, tool_choice:)
             params
           end
 
+          # Build an Anthropic message
+          #
+          # @param role [String] The role of the message
+          # @param content [String] The content of the message
+          # @param image_url [String] The image URL
+          # @param tool_calls [Array<Hash>] The tool calls
+          # @param tool_call_id [String] The tool call ID
+          # @return [Messages::AnthropicMessage] The Anthropic message
           def build_message(role:, content: nil, image_url: nil, tool_calls: [], tool_call_id: nil)
             warn "Image URL is not supported by Anthropic currently" if image_url
 
-            Langchain::Messages::AnthropicMessage.new(role: role, content: content, tool_calls: tool_calls, tool_call_id: tool_call_id)
+            Messages::AnthropicMessage.new(role: role, content: content, tool_calls: tool_calls, tool_call_id: tool_call_id)
           end
 
           # Extract the tool call information from the Anthropic tool call hash
@@ -31,14 +48,20 @@ def extract_tool_call_args(tool_call:)
             [tool_call_id, tool_name, method_name, tool_arguments]
           end
 
+          # Build the tools for the Anthropic API
           def build_tools(tools)
             tools.map { |tool| tool.class.function_schemas.to_anthropic_format }.flatten
           end
 
+          # Get the allowed assistant.tool_choice values for Anthropic
           def allowed_tool_choices
             ["auto", "any"]
           end
 
+          # Get the available tool function names for Anthropic
+          #
+          # @param tools [Array<Hash>] The tools
+          # @return [Array<String>] The tool function names
           def available_tool_names(tools)
             build_tools(tools).map { |tool| tool.dig(:name) }
           end

lib/langchain/assistants/llm/adapters/anthropic.rb renamed to lib/langchain/assistant/llm/adapters/anthropic.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Langchain
+  class Assistant
+    module LLM
+      module Adapters
+        class Base
+          # Build the chat parameters for the LLM
+          #
+          # @param tools [Array] The tools to use
+          # @param instructions [String] The system instructions
+          # @param messages [Array] The messages
+          # @param tool_choice [String] The tool choice
+          # @return [Hash] The chat parameters
+          def build_chat_params(tools:, instructions:, messages:, tool_choice:)
+            raise NotImplementedError, "Subclasses must implement build_chat_params"
+          end
+
+          # Extract the tool call information from the tool call hash
+          #
+          # @param tool_call [Hash] The tool call hash
+          # @return [Array] The tool call information
+          def extract_tool_call_args(tool_call:)
+            raise NotImplementedError, "Subclasses must implement extract_tool_call_args"
+          end
+
+          # Build a message for the LLM
+          #
+          # @param role [String] The role of the message
+          # @param content [String] The content of the message
+          # @param image_url [String] The image URL
+          # @param tool_calls [Array] The tool calls
+          # @param tool_call_id [String] The tool call ID
+          # @return [Messages::Base] The message
+          def build_message(role:, content: nil, image_url: nil, tool_calls: [], tool_call_id: nil)
+            raise NotImplementedError, "Subclasses must implement build_message"
+          end
+        end
+      end
+    end
+  end
+end

lib/langchain/assistant/llm/adapters/base.rb

@@ -1,8 +1,17 @@
+# frozen_string_literal: true
+
 module Langchain
   class Assistant
     module LLM
       module Adapters
         class GoogleGemini < Base
+          # Build the chat parameters for the Google Gemini LLM
+          #
+          # @param tools [Array] The tools to use
+          # @param instructions [String] The system instructions
+          # @param messages [Array] The messages
+          # @param tool_choice [String] The tool choice
+          # @return [Hash] The chat parameters
           def build_chat_params(tools:, instructions:, messages:, tool_choice:)
             params = {messages: messages}
             if tools.any?
@@ -13,10 +22,18 @@ def build_chat_params(tools:, instructions:, messages:, tool_choice:)
             params
           end
 
+          # Build a Google Gemini message
+          #
+          # @param role [String] The role of the message
+          # @param content [String] The content of the message
+          # @param image_url [String] The image URL
+          # @param tool_calls [Array] The tool calls
+          # @param tool_call_id [String] The tool call ID
+          # @return [Messages::GoogleGeminiMessage] The Google Gemini message
           def build_message(role:, content: nil, image_url: nil, tool_calls: [], tool_call_id: nil)
             warn "Image URL is not supported by Google Gemini" if image_url
 
-            Langchain::Messages::GoogleGeminiMessage.new(role: role, content: content, tool_calls: tool_calls, tool_call_id: tool_call_id)
+            Messages::GoogleGeminiMessage.new(role: role, content: content, tool_calls: tool_calls, tool_call_id: tool_call_id)
           end
 
           # Extract the tool call information from the Google Gemini tool call hash
@@ -31,14 +48,20 @@ def extract_tool_call_args(tool_call:)
             [tool_call_id, tool_name, method_name, tool_arguments]
           end
 
+          # Build the tools for the Google Gemini LLM
+          #
+          # @param tools [Array<Langchain::Tool::Base>] The tools
+          # @return [Array] The tools in Google Gemini format
           def build_tools(tools)
             tools.map { |tool| tool.class.function_schemas.to_google_gemini_format }.flatten
           end
 
+          # Get the allowed assistant.tool_choice values for Google Gemini
           def allowed_tool_choices
             ["auto", "none"]
           end
 
+          # Get the available tool names for Google Gemini
           def available_tool_names(tools)
             build_tools(tools).map { |tool| tool.dig(:name) }
           end

lib/langchain/assistants/llm/adapters/google_gemini.rb renamed to lib/langchain/assistant/llm/adapters/google_gemini.rb

@@ -1,8 +1,17 @@
+# frozen_string_literal: true
+
 module Langchain
   class Assistant
     module LLM
       module Adapters
         class MistralAI < Base
+          # Build the chat parameters for the Mistral AI LLM
+          #
+          # @param tools [Array] The tools to use
+          # @param instructions [String] The system instructions
+          # @param messages [Array] The messages
+          # @param tool_choice [String] The tool choice
+          # @return [Hash] The chat parameters
           def build_chat_params(tools:, instructions:, messages:, tool_choice:)
             params = {messages: messages}
             if tools.any?
@@ -12,8 +21,16 @@ def build_chat_params(tools:, instructions:, messages:, tool_choice:)
             params
           end
 
+          # Build a Mistral AI message
+          #
+          # @param role [String] The role of the message
+          # @param content [String] The content of the message
+          # @param image_url [String] The image URL
+          # @param tool_calls [Array] The tool calls
+          # @param tool_call_id [String] The tool call ID
+          # @return [Messages::MistralAIMessage] The Mistral AI message
           def build_message(role:, content: nil, image_url: nil, tool_calls: [], tool_call_id: nil)
-            Langchain::Messages::MistralAIMessage.new(role: role, content: content, image_url: image_url, tool_calls: tool_calls, tool_call_id: tool_call_id)
+            Messages::MistralAIMessage.new(role: role, content: content, image_url: image_url, tool_calls: tool_calls, tool_call_id: tool_call_id)
           end
 
           # Extract the tool call information from the OpenAI tool call hash
@@ -36,14 +53,17 @@ def extract_tool_call_args(tool_call:)
             [tool_call_id, tool_name, method_name, tool_arguments]
           end
 
+          # Build the tools for the Mistral AI LLM
           def build_tools(tools)
             tools.map { |tool| tool.class.function_schemas.to_openai_format }.flatten
           end
 
+          # Get the allowed assistant.tool_choice values for Mistral AI
           def allowed_tool_choices
             ["auto", "none"]
           end
 
+          # Get the available tool names for Mistral AI
           def available_tool_names(tools)
             build_tools(tools).map { |tool| tool.dig(:function, :name) }
           end

lib/langchain/assistants/llm/adapters/mistral_ai.rb renamed to lib/langchain/assistant/llm/adapters/mistral_ai.rb

@@ -1,8 +1,17 @@
+# frozen_string_literal: true
+
 module Langchain
   class Assistant
     module LLM
       module Adapters
         class Ollama < Base
+          # Build the chat parameters for the Ollama LLM
+          #
+          # @param tools [Array] The tools to use
+          # @param instructions [String] The system instructions
+          # @param messages [Array] The messages
+          # @param tool_choice [String] The tool choice
+          # @return [Hash] The chat parameters
           def build_chat_params(tools:, instructions:, messages:, tool_choice:)
             params = {messages: messages}
             if tools.any?
@@ -11,10 +20,18 @@ def build_chat_params(tools:, instructions:, messages:, tool_choice:)
             params
           end
 
+          # Build an Ollama message
+          #
+          # @param role [String] The role of the message
+          # @param content [String] The content of the message
+          # @param image_url [String] The image URL
+          # @param tool_calls [Array] The tool calls
+          # @param tool_call_id [String] The tool call ID
+          # @return [Messages::OllamaMessage] The Ollama message
           def build_message(role:, content: nil, image_url: nil, tool_calls: [], tool_call_id: nil)
             warn "Image URL is not supported by Ollama currently" if image_url
 
-            Langchain::Messages::OllamaMessage.new(role: role, content: content, tool_calls: tool_calls, tool_call_id: tool_call_id)
+            Messages::OllamaMessage.new(role: role, content: content, tool_calls: tool_calls, tool_call_id: tool_call_id)
           end
 
           # Extract the tool call information from the OpenAI tool call hash
@@ -37,10 +54,12 @@ def extract_tool_call_args(tool_call:)
             [tool_call_id, tool_name, method_name, tool_arguments]
           end
 
+          # Build the tools for the Ollama LLM
           def available_tool_names(tools)
             build_tools(tools).map { |tool| tool.dig(:function, :name) }
           end
 
+          # Get the allowed assistant.tool_choice values for Ollama
           def allowed_tool_choices
             ["auto", "none"]
           end