langchainrb 0.15.4 → 0.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68d2d64fb264bf47488e83581540b88f7746f0e1b1b318d7dfc9c15356f40c8c
-  data.tar.gz: efbd840632f0f22b202d9257a2020c4bc49cea7528d79efa7e05f963e9e4745f
+  metadata.gz: cb478a5261da82b78d6a90b6179e4050ae0fcba274c370b507f546b59cfd1a78
+  data.tar.gz: 7fb27d8b3c68060e923e69b1c67680be20846e5a384def4c6ce0efd1c9fa56ab
 SHA512:
-  metadata.gz: f57817cc62de3af8f9aa80c62e421255e4172f55d54d91c1adc7d7a03ac9272e866670532c996a19d502c6d3110627d778efdad8c4faad0b07868c8b0aebc81c
-  data.tar.gz: b35d82314edc0d747c87a37bd0e2036755f884e85977639e8b53063ca8ebd7002b9dd4ae9a5dd443f088552e575471e080dc9aa4519e25efaa908e16130b613a
+  metadata.gz: b6533a4064e822c78cc7659c55c948b13b4904d75ab99fb50269f82d7f815e02ff3c0659f0b6c1905b16c0834f2577ccd136cb3d1a34db6e26b7352c77350a10
+  data.tar.gz: 170e767e0fdef21fc6051a161904ee867205bb18a98641b545adf7fe3933b499d157be52009fd20e168efa5d94e5a03c39a1a21c94c2747b8e6a0393f2099e4e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.15.4] - 2024-09-10 🇧🇦
+- Fix for Langchain::Prompt::PromptTemplate supporting nested JSON data
+- Require common libs at top-level
+- Add `add_message_callback` to `Langchain::Assistant` constructor to invoke an optional function when any message is added to the conversation
+- Adding Assistant syntactic sugar with #run! and #add_message_and_run!
+
 ## [0.15.4] - 2024-08-30
 - Improve the Langchain::Tool::Database tool
 - Allow explictly setting tool_choice on the Assistant instance

data/README.md

@@ -427,7 +427,7 @@ assistant.add_message_and_run(content: "What's the latest news about AI?")
 messages = assistant.messages
 
 # Run the assistant with automatic tool execution
-assistant.run(auto_tool_execution: true)
+assistant.run!
 ```
 
 ### Configuration
@@ -435,11 +435,12 @@ assistant.run(auto_tool_execution: true)
 * `tools`: An array of tool instances (optional)
 * `instructions`: System instructions for the assistant (optional)
 * `tool_choice`: Specifies how tools should be selected. Default: "auto". A specific tool function name can be passed. This will force the Assistant to **always** use this function.
+* `add_message_callback`: A callback function (proc, lambda) that is called when any message is added to the conversation (optional)
 
 ### Key Methods
 * `add_message`: Adds a user message to the messages array
-* `run`: Processes the conversation and generates responses
-* `add_message_and_run`: Combines adding a message and running the assistant
+* `run!`: Processes the conversation and generates responses
+* `add_message_and_run!`: Combines adding a message and running the assistant
 * `submit_tool_output`: Manually submit output to a tool call
 * `messages`: Returns a list of ongoing messages
 

data/lib/langchain/assistants/assistant.rb

@@ -30,7 +30,8 @@ module Langchain
       thread: nil,
       tools: [],
       instructions: nil,
-      tool_choice: "auto"
+      tool_choice: "auto",
+      add_message_callback: nil
     )
       unless tools.is_a?(Array) && tools.all? { |tool| tool.class.singleton_class.included_modules.include?(Langchain::ToolDefinition) }
         raise ArgumentError, "Tools must be an array of objects extending Langchain::ToolDefinition"
@@ -38,7 +39,10 @@ module Langchain
 
       @llm = llm
       @llm_adapter = LLM::Adapter.build(llm)
+
       @thread = thread || Langchain::Thread.new
+      @thread.add_message_callback = add_message_callback
+
       @tools = tools
       self.tool_choice = tool_choice
       @instructions = instructions
@@ -51,9 +55,8 @@ module Langchain
       raise ArgumentError, "Thread must be an instance of Langchain::Thread" unless @thread.is_a?(Langchain::Thread)
 
       # The first message in the thread should be the system instructions
-      # TODO: What if the user added old messages and the system instructions are already in there? Should this overwrite the existing instructions?
-      initialize_instructions
       # For Google Gemini, and Anthropic system instructions are added to the `system:` param in the `chat` method
+      initialize_instructions
     end
 
     # Add a user message to the thread
@@ -107,6 +110,13 @@ module Langchain
       thread.messages
     end
 
+    # Run the assistant with automatic tool execution
+    #
+    # @return [Array<Langchain::Message>] The messages in the thread
+    def run!
+      run(auto_tool_execution: true)
+    end
+
     # Add a user message to the thread and run the assistant
     #
     # @param content [String] The content of the message
@@ -117,6 +127,14 @@ module Langchain
       run(auto_tool_execution: auto_tool_execution)
     end
 
+    # Add a user message to the thread and run the assistant with automatic tool execution
+    #
+    # @param content [String] The content of the message
+    # @return [Array<Langchain::Message>] The messages in the thread
+    def add_message_and_run!(content:)
+      add_message_and_run(content: content, auto_tool_execution: true)
+    end
+
     # Submit tool output to the thread
     #
     # @param tool_call_id [String] The ID of the tool call to submit output for
@@ -287,7 +305,7 @@ module Langchain
 
     def initialize_instructions
       if llm.is_a?(Langchain::LLM::OpenAI) || llm.is_a?(Langchain::LLM::MistralAI)
-        add_message(role: "system", content: instructions) if instructions
+        self.instructions = @instructions if @instructions
       end
     end
 

data/lib/langchain/assistants/thread.rb

@@ -4,12 +4,14 @@ module Langchain
   # Langchain::Thread keeps track of messages in a conversation.
   # TODO: Add functionality to persist to the thread to disk, DB, storage, etc.
   class Thread
-    attr_accessor :messages
+    attr_accessor :messages, :add_message_callback
 
     # @param messages [Array<Langchain::Message>]
-    def initialize(messages: [])
+    # @param add_message_callback [Proc] A callback to call when a message is added to the thread
+    def initialize(messages: [], add_message_callback: nil)
       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) }
 
+      @add_message_callback = add_message_callback
       @messages = messages
     end
 
@@ -34,6 +36,9 @@ module Langchain
     def add_message(message)
       raise ArgumentError, "message must be a Langchain::Message instance" unless message.is_a?(Langchain::Messages::Base)
 
+      # Call the callback with the message
+      add_message_callback.call(message) if add_message_callback # rubocop:disable Style/SafeNavigation
+
       # Prepend the message to the thread
       messages << message
     end

data/lib/langchain/output_parsers/structured_output_parser.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "json"
 require "json-schema"
 
 module Langchain::OutputParsers

data/lib/langchain/processors/eml.rb

@@ -1,4 +1,4 @@
-require "uri"
+# frozen_string_literal: true
 
 module Langchain
   module Processors

data/lib/langchain/prompt/base.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "strscan"
-require "json"
 require "yaml"
 
 module Langchain::Prompt

data/lib/langchain/prompt/loading.rb

@@ -2,7 +2,6 @@
 
 require "strscan"
 require "pathname"
-require "json"
 require "yaml"
 
 module Langchain::Prompt

data/lib/langchain/prompt/prompt_template.rb

@@ -58,8 +58,9 @@ module Langchain::Prompt
     #
     def format(**kwargs)
       result = @template
+      result = result.gsub(/{{/, "{").gsub(/}}/, "}")
       kwargs.each { |key, value| result = result.gsub(/\{#{key}\}/, value.to_s) }
-      result.gsub(/{{/, "{").gsub(/}}/, "}")
+      result
     end
 
     #

data/lib/langchain/tool_definition.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "json"
-
 #
 # Extends a class to be used as a tool in the assistant.
 # A tool is a collection of functions (methods) used to perform specific tasks.
@@ -42,8 +40,8 @@ module Langchain::ToolDefinition
   # @param method_name [Symbol] Name of the method to define
   # @param description [String] Description of the function
   # @yield Block that defines the parameters for the function
-  def define_function(method_name, description:, &)
-    function_schemas.add_function(method_name:, description:, &)
+  def define_function(method_name, description:, &block)
+    function_schemas.add_function(method_name:, description:, &block)
   end
 
   # Returns the FunctionSchemas instance for this tool
@@ -76,11 +74,11 @@ module Langchain::ToolDefinition
     # @param description [String] Description of the function
     # @yield Block that defines the parameters for the function
     # @raise [ArgumentError] If a block is defined and no parameters are specified for the function
-    def add_function(method_name:, description:, &)
+    def add_function(method_name:, description:, &block)
       name = "#{@tool_name}__#{method_name}"
 
-      if block_given?
-        parameters = ParameterBuilder.new(parent_type: "object").build(&)
+      if block_given? # rubocop:disable Performance/BlockGivenWithExplicitBlock
+        parameters = ParameterBuilder.new(parent_type: "object").build(&block)
 
         if parameters[:properties].empty?
           raise ArgumentError, "Function parameters must have at least one property defined within it, if a block is provided"
@@ -130,8 +128,8 @@ module Langchain::ToolDefinition
     #
     # @yield Block that defines the properties of the schema
     # @return [Hash] The built schema
-    def build(&)
-      instance_eval(&)
+    def build(&block)
+      instance_eval(&block)
       @schema
     end
 
@@ -144,13 +142,13 @@ module Langchain::ToolDefinition
     # @param required [Boolean] Whether the property is required
     # @yield [Block] Block for nested properties (only for object and array types)
     # @raise [ArgumentError] If any parameter is invalid
-    def property(name = nil, type:, description: nil, enum: nil, required: false, &)
+    def property(name = nil, type:, description: nil, enum: nil, required: false, &block)
       validate_parameters(name:, type:, enum:, required:)
 
       prop = {type:, description:, enum:}.compact
 
-      if block_given?
-        nested_schema = ParameterBuilder.new(parent_type: type).build(&)
+      if block_given? # rubocop:disable Performance/BlockGivenWithExplicitBlock
+        nested_schema = ParameterBuilder.new(parent_type: type).build(&block)
 
         case type
         when "object"

data/lib/langchain/vectorsearch/epsilla.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 require "securerandom"
-require "json"
 require "timeout"
-require "uri"
 
 module Langchain::Vectorsearch
   class Epsilla < Base

data/lib/langchain/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Langchain
-  VERSION = "0.15.4"
+  VERSION = "0.15.5"
 end

data/lib/langchain.rb

@@ -4,6 +4,9 @@ require "logger"
 require "pathname"
 require "rainbow"
 require "zeitwerk"
+require "uri"
+require "json"
+
 loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/langchainrb.rb")
 loader.inflector.inflect(
@@ -30,6 +33,7 @@ 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")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: langchainrb
 version: !ruby/object:Gem::Version
-  version: 0.15.4
+  version: 0.15.5
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: baran