langchainrb 0.19.3 → 0.19.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5567aa14daf63f120a6c2b2b2991fbd85b650b4cb4e2ac49703736dacd46197e
-  data.tar.gz: ee71c45590998793c343c9620565cfcfdff5cd2d715091f3ad6804d54b814444
+  metadata.gz: 65a5c3e4eb0dcf204f75f20fde73d4e049fe657177e19d3fbcc8ffefad059776
+  data.tar.gz: 167a2e8c9305859afc8d384a3b2ff33ea7fc77f7abe7feb93a8f6c104effd2f3
 SHA512:
-  metadata.gz: a5d212aadfef3ca07a6c9dc517141f0e6dedb1e414b0e8bbcbc0b7abddd5e2405a8a07ab6cc10efd66ee8997c41b5c8bd82ea8755d0f8e5fea7728db94f82379
-  data.tar.gz: a3a5a5c62cc075e8d09c0e6b629e1ec8b118d35d98e4de107c48d779d8b35261de3ad0061e22a4be4b2aefc15bbb25c20f658fe1f0a694ecc87279cd21309ff8
+  metadata.gz: 7b65c3e5ef0f7774f634157a98e2fdb2db57fcb9981c96c0ae476ef78ee4a4a3d4822c48339543b0cd0e4d708bf043f2d9653fdfdda5f0df093ea01839d033e3
+  data.tar.gz: e93b0e741cf729697067a4d89b0c938e8261cc8df3d0b30dc0a1dbbb03a0f6100ede5120e2ba8f2d7cc65cf6b5707061d64a4b6e101020413713ef445c0265be

data/CHANGELOG.md

@@ -11,6 +11,10 @@
 
 ## [Unreleased]
 
+## [0.19.4] - 2025-02-17
+- [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/894] Tools can now output image_urls, and all tool output must be wrapped by a tool_response() method
+- [BUGFIX] [https://github.com/patterns-ai-core/langchainrb/pull/921] Fix for Assistant when OpenAI o1/o3 models are used
+
 ## [0.19.3] - 2025-01-13
 - [BUGFIX] [https://github.com/patterns-ai-core/langchainrb/pull/900] Empty text content should not be set when content is nil when using AnthropicMessage
 

data/README.md

@@ -580,11 +580,11 @@ class MovieInfoTool
   end
 
   def search_movie(query:)
-    ...
+    tool_response(...)
   end
 
   def get_movie_details(movie_id:)
-    ...
+    tool_response(...)
   end
 end
 ```

data/lib/langchain/assistant/llm/adapters/openai.rb

@@ -24,7 +24,9 @@ module Langchain
             if tools.any?
               params[:tools] = build_tools(tools)
               params[:tool_choice] = build_tool_choice(tool_choice)
-              params[:parallel_tool_calls] = parallel_tool_calls
+              # Temporary fix because OpenAI o1/o3/reasoning models don't support `parallel_tool_calls` parameter.
+              # Set `Assistant.new(parallel_tool_calls: nil, ...)` to avoid the error.
+              params[:parallel_tool_calls] = parallel_tool_calls unless parallel_tool_calls.nil?
             end
             params
           end

data/lib/langchain/assistant.rb

@@ -371,9 +371,15 @@ module Langchain
 
       # Call the callback if set
       tool_execution_callback.call(tool_call_id, tool_name, method_name, tool_arguments) if tool_execution_callback # rubocop:disable Style/SafeNavigation
+
       output = tool_instance.send(method_name, **tool_arguments)
 
-      submit_tool_output(tool_call_id: tool_call_id, output: output)
+      # Handle both ToolResponse and legacy return values
+      if output.is_a?(ToolResponse)
+        add_message(role: @llm_adapter.tool_role, content: output.content, image_url: output.image_url, tool_call_id: tool_call_id)
+      else
+        submit_tool_output(tool_call_id: tool_call_id, output: output)
+      end
     end
 
     # Build a message

data/lib/langchain/output_parsers/base.rb

@@ -28,15 +28,4 @@ module Langchain::OutputParsers
       raise NotImplementedError
     end
   end
-
-  class OutputParserException < StandardError
-    def initialize(message, text)
-      @message = message
-      @text = text
-    end
-
-    def to_s
-      "#{@message}\nText: #{@text}"
-    end
-  end
 end

data/lib/langchain/output_parsers/output_parser_exception.rb

@@ -0,0 +1,10 @@
+class Langchain::OutputParsers::OutputParserException < StandardError
+  def initialize(message, text)
+    @message = message
+    @text = text
+  end
+
+  def to_s
+    "#{@message}\nText: #{@text}"
+  end
+end

data/lib/langchain/tool/calculator.rb

@@ -26,13 +26,14 @@ module Langchain::Tool
     # Evaluates a pure math expression or if equation contains non-math characters (e.g.: "12F in Celsius") then it uses the google search calculator to evaluate the expression
     #
     # @param input [String] math expression
-    # @return [String] Answer
+    # @return [Langchain::Tool::Response] Answer
     def execute(input:)
       Langchain.logger.debug("#{self.class} - Executing \"#{input}\"")
 
-      Eqn::Calculator.calc(input)
+      result = Eqn::Calculator.calc(input)
+      tool_response(content: result)
     rescue Eqn::ParseError, Eqn::NoVariableValueError
-      "\"#{input}\" is an invalid mathematical expression"
+      tool_response(content: "\"#{input}\" is an invalid mathematical expression")
     end
   end
 end

data/lib/langchain/tool/database.rb

@@ -49,50 +49,53 @@ module Langchain::Tool
 
     # Database Tool: Returns a list of tables in the database
     #
-    # @return [Array<Symbol>] List of tables in the database
+    # @return [Langchain::Tool::Response] List of tables in the database
     def list_tables
-      db.tables
+      tool_response(content: db.tables)
     end
 
     # Database Tool: Returns the schema for a list of tables
     #
     # @param tables [Array<String>] The tables to describe.
-    # @return [String] The schema for the tables
+    # @return [Langchain::Tool::Response] The schema for the tables
     def describe_tables(tables: [])
       return "No tables specified" if tables.empty?
 
       Langchain.logger.debug("#{self.class} - Describing tables: #{tables}")
 
-      tables
+      result = tables
         .map do |table|
           describe_table(table)
         end
         .join("\n")
+
+      tool_response(content: result)
     end
 
     # Database Tool: Returns the database schema
     #
-    # @return [String] Database schema
+    # @return [Langchain::Tool::Response] Database schema
     def dump_schema
       Langchain.logger.debug("#{self.class} - Dumping schema tables and keys")
 
       schemas = db.tables.map do |table|
         describe_table(table)
       end
-      schemas.join("\n")
+
+      tool_response(content: schemas.join("\n"))
     end
 
     # Database Tool: Executes a SQL query and returns the results
     #
     # @param input [String] SQL query to be executed
-    # @return [Array] Results from the SQL query
+    # @return [Langchain::Tool::Response] Results from the SQL query
     def execute(input:)
       Langchain.logger.debug("#{self.class} - Executing \"#{input}\"")
 
-      db[input].to_a
+      tool_response(content: db[input].to_a)
     rescue Sequel::DatabaseError => e
       Langchain.logger.error("#{self.class} - #{e.message}")
-      e.message # Return error to LLM
+      tool_response(content: e.message)
     end
 
     private
@@ -100,7 +103,7 @@ module Langchain::Tool
     # Describes a table and its schema
     #
     # @param table [String] The table to describe
-    # @return [String] The schema for the table
+    # @return [Langchain::Tool::Response] The schema for the table
     def describe_table(table)
       # TODO: There's probably a clear way to do all of this below
 
@@ -127,6 +130,8 @@ module Langchain::Tool
         schema << ",\n" unless fk == db.foreign_key_list(table).last
       end
       schema << ");\n"
+
+      tool_response(content: schema)
     end
   end
 end

data/lib/langchain/tool/file_system.rb

@@ -24,21 +24,22 @@ module Langchain::Tool
     end
 
     def list_directory(directory_path:)
-      Dir.entries(directory_path)
+      tool_response(content: Dir.entries(directory_path))
     rescue Errno::ENOENT
-      "No such directory: #{directory_path}"
+      tool_response(content: "No such directory: #{directory_path}")
     end
 
     def read_file(file_path:)
-      File.read(file_path)
+      tool_response(content: File.read(file_path))
     rescue Errno::ENOENT
-      "No such file: #{file_path}"
+      tool_response(content: "No such file: #{file_path}")
     end
 
     def write_to_file(file_path:, content:)
       File.write(file_path, content)
+      tool_response(content: "File written successfully")
     rescue Errno::EACCES
-      "Permission denied: #{file_path}"
+      tool_response(content: "Permission denied: #{file_path}")
     end
   end
 end

data/lib/langchain/tool/google_search.rb

@@ -36,7 +36,7 @@ module Langchain::Tool
     # Executes Google Search and returns the result
     #
     # @param input [String] search query
-    # @return [String] Answer
+    # @return [Langchain::Tool::Response] Answer
     def execute(input:)
       Langchain.logger.debug("#{self.class} - Executing \"#{input}\"")
 
@@ -44,31 +44,31 @@ module Langchain::Tool
 
       answer_box = results[:answer_box_list] ? results[:answer_box_list].first : results[:answer_box]
       if answer_box
-        return answer_box[:result] ||
+        return tool_response(content: answer_box[:result] ||
             answer_box[:answer] ||
             answer_box[:snippet] ||
             answer_box[:snippet_highlighted_words] ||
-            answer_box.reject { |_k, v| v.is_a?(Hash) || v.is_a?(Array) || v.start_with?("http") }
+            answer_box.reject { |_k, v| v.is_a?(Hash) || v.is_a?(Array) || v.start_with?("http") })
       elsif (events_results = results[:events_results])
-        return events_results.take(10)
+        return tool_response(content: events_results.take(10))
       elsif (sports_results = results[:sports_results])
-        return sports_results
+        return tool_response(content: sports_results)
       elsif (top_stories = results[:top_stories])
-        return top_stories
+        return tool_response(content: top_stories)
       elsif (news_results = results[:news_results])
-        return news_results
+        return tool_response(content: news_results)
       elsif (jobs_results = results.dig(:jobs_results, :jobs))
-        return jobs_results
+        return tool_response(content: jobs_results)
       elsif (shopping_results = results[:shopping_results]) && shopping_results.first.key?(:title)
-        return shopping_results.take(3)
+        return tool_response(content: shopping_results.take(3))
       elsif (questions_and_answers = results[:questions_and_answers])
-        return questions_and_answers
+        return tool_response(content: questions_and_answers)
       elsif (popular_destinations = results.dig(:popular_destinations, :destinations))
-        return popular_destinations
+        return tool_response(content: popular_destinations)
       elsif (top_sights = results.dig(:top_sights, :sights))
-        return top_sights
+        return tool_response(content: top_sights)
       elsif (images_results = results[:images_results]) && images_results.first.key?(:thumbnail)
-        return images_results.map { |h| h[:thumbnail] }.take(10)
+        return tool_response(content: images_results.map { |h| h[:thumbnail] }.take(10))
       end
 
       snippets = []
@@ -110,8 +110,8 @@ module Langchain::Tool
         snippets << local_results
       end
 
-      return "No good search result found" if snippets.empty?
-      snippets
+      return tool_response(content: "No good search result found") if snippets.empty?
+      tool_response(content: snippets)
     end
 
     #

data/lib/langchain/tool/news_retriever.rb

@@ -57,7 +57,7 @@ module Langchain::Tool
     # @param page_size [Integer] The number of results to return per page. 20 is the API's default, 100 is the maximum. Our default is 5.
     # @param page [Integer] Use this to page through the results.
     #
-    # @return [String] JSON response
+    # @return [Langchain::Tool::Response] JSON response
     def get_everything(
       q: nil,
       search_in: nil,
@@ -86,7 +86,8 @@ module Langchain::Tool
       params[:pageSize] = page_size if page_size
       params[:page] = page if page
 
-      send_request(path: "everything", params: params)
+      response = send_request(path: "everything", params: params)
+      tool_response(content: response)
     end
 
     # Retrieve top headlines
@@ -98,7 +99,7 @@ module Langchain::Tool
     # @param page_size [Integer] The number of results to return per page. 20 is the API's default, 100 is the maximum. Our default is 5.
     # @param page [Integer] Use this to page through the results.
     #
-    # @return [String] JSON response
+    # @return [Langchain::Tool::Response] JSON response
     def get_top_headlines(
       country: nil,
       category: nil,
@@ -117,7 +118,8 @@ module Langchain::Tool
       params[:pageSize] = page_size if page_size
       params[:page] = page if page
 
-      send_request(path: "top-headlines", params: params)
+      response = send_request(path: "top-headlines", params: params)
+      tool_response(content: response)
     end
 
     # Retrieve news sources
@@ -126,7 +128,7 @@ module Langchain::Tool
     # @param language [String] The 2-letter ISO-639-1 code of the language you want to get headlines for. Possible options: ar, de, en, es, fr, he, it, nl, no, pt, ru, se, ud, zh.
     # @param country [String] The 2-letter ISO 3166-1 code of the country you want to get headlines for. Possible options: ae, ar, at, au, be, bg, br, ca, ch, cn, co, cu, cz, de, eg, fr, gb, gr, hk, hu, id, ie, il, in, it, jp, kr, lt, lv, ma, mx, my, ng, nl, no, nz, ph, pl, pt, ro, rs, ru, sa, se, sg, si, sk, th, tr, tw, ua, us, ve, za.
     #
-    # @return [String] JSON response
+    # @return [Langchain::Tool::Response] JSON response
     def get_sources(
       category: nil,
       language: nil,
@@ -139,7 +141,8 @@ module Langchain::Tool
       params[:category] = category if category
       params[:language] = language if language
 
-      send_request(path: "top-headlines/sources", params: params)
+      response = send_request(path: "top-headlines/sources", params: params)
+      tool_response(content: response)
     end
 
     private

data/lib/langchain/tool/ruby_code_interpreter.rb

@@ -27,11 +27,11 @@ module Langchain::Tool
     # Executes Ruby code in a sandboxes environment.
     #
     # @param input [String] ruby code expression
-    # @return [String] Answer
+    # @return [Langchain::Tool::Response] Answer
     def execute(input:)
       Langchain.logger.debug("#{self.class} - Executing \"#{input}\"")
 
-      safe_eval(input)
+      tool_response(content: safe_eval(input))
     end
 
     def safe_eval(code)

data/lib/langchain/tool/tavily.rb

@@ -41,7 +41,7 @@ module Langchain::Tool
     # @param include_domains [Array<String>] A list of domains to specifically include in the search results. Default is None, which includes all domains.
     # @param exclude_domains [Array<String>] A list of domains to specifically exclude from the search results. Default is None, which doesn't exclude any domains.
     #
-    # @return [String] The search results in JSON format.
+    # @return [Langchain::Tool::Response] The search results in JSON format.
     def search(
       query:,
       search_depth: "basic",
@@ -70,7 +70,7 @@ module Langchain::Tool
       response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
         http.request(request)
       end
-      response.body
+      tool_response(content: response.body)
     end
   end
 end

data/lib/langchain/tool/vectorsearch.rb

@@ -33,8 +33,10 @@ module Langchain::Tool
     #
     # @param query [String] The query to search for
     # @param k [Integer] The number of results to return
+    # @return [Langchain::Tool::Response] The response from the server
     def similarity_search(query:, k: 4)
-      vectorsearch.similarity_search(query:, k: 4)
+      result = vectorsearch.similarity_search(query:, k: 4)
+      tool_response(content: result)
     end
   end
 end

data/lib/langchain/tool/weather.rb

@@ -55,15 +55,15 @@ module Langchain::Tool
       params = {appid: @api_key, q: [city, state_code, country_code].compact.join(","), units: units}
 
       location_response = send_request(path: "geo/1.0/direct", params: params.except(:units))
-      return location_response if location_response.is_a?(String) # Error occurred
+      return tool_response(content: location_response) if location_response.is_a?(String) # Error occurred
 
       location = location_response.first
-      return "Location not found" unless location
+      return tool_response(content: "Location not found") unless location
 
       params = params.merge(lat: location["lat"], lon: location["lon"]).except(:q)
       weather_data = send_request(path: "data/2.5/weather", params: params)
 
-      parse_weather_response(weather_data, units)
+      tool_response(content: parse_weather_response(weather_data, units))
     end
 
     def send_request(path:, params:)

data/lib/langchain/tool/wikipedia.rb

@@ -27,13 +27,13 @@ module Langchain::Tool
     # Executes Wikipedia API search and returns the answer
     #
     # @param input [String] search query
-    # @return [String] Answer
+    # @return [Langchain::Tool::Response] Answer
     def execute(input:)
       Langchain.logger.debug("#{self.class} - Executing \"#{input}\"")
 
       page = ::Wikipedia.find(input)
       # It would be nice to figure out a way to provide page.content but the LLM token limit is an issue
-      page.summary
+      tool_response(content: page.summary)
     end
   end
 end

data/lib/langchain/tool_definition.rb

@@ -61,6 +61,20 @@ module Langchain::ToolDefinition
       .downcase
   end
 
+  def self.extended(base)
+    base.include(InstanceMethods)
+  end
+
+  module InstanceMethods
+    # Create a tool response
+    # @param content [String, nil] The content of the tool response
+    # @param image_url [String, nil] The URL of an image
+    # @return [Langchain::ToolResponse] The tool response
+    def tool_response(content: nil, image_url: nil)
+      Langchain::ToolResponse.new(content: content, image_url: image_url)
+    end
+  end
+
   # Manages schemas for functions
   class FunctionSchemas
     def initialize(tool_name)

data/lib/langchain/tool_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Langchain
+  # ToolResponse represents the standardized output of a tool.
+  # It can contain either text content or an image URL.
+  class ToolResponse
+    attr_reader :content, :image_url
+
+    # Initializes a new ToolResponse.
+    #
+    # @param content [String] The text content of the response.
+    # @param image_url [String, nil] Optional URL to an image.
+    def initialize(content: nil, image_url: nil)
+      raise ArgumentError, "Either content or image_url must be provided" if content.nil? && image_url.nil?
+
+      @content = content
+      @image_url = image_url
+    end
+
+    def to_s
+      content.to_s
+    end
+  end
+end

data/lib/langchain/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: langchainrb
 version: !ruby/object:Gem::Version
-  version: 0.19.3
+  version: 0.19.4
 platform: ruby
 authors:
 - Andrei Bondarev
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: baran
@@ -718,6 +717,7 @@ files:
 - lib/langchain/loader.rb
 - lib/langchain/output_parsers/base.rb
 - lib/langchain/output_parsers/output_fixing_parser.rb
+- lib/langchain/output_parsers/output_parser_exception.rb
 - lib/langchain/output_parsers/prompts/naive_fix_prompt.yaml
 - lib/langchain/output_parsers/structured_output_parser.rb
 - lib/langchain/processors/base.rb
@@ -749,6 +749,7 @@ files:
 - lib/langchain/tool/weather.rb
 - lib/langchain/tool/wikipedia.rb
 - lib/langchain/tool_definition.rb
+- lib/langchain/tool_response.rb
 - lib/langchain/utils/cosine_similarity.rb
 - lib/langchain/utils/hash_transformer.rb
 - lib/langchain/utils/image_wrapper.rb
@@ -775,7 +776,6 @@ metadata:
   source_code_uri: https://github.com/patterns-ai-core/langchainrb
   changelog_uri: https://github.com/patterns-ai-core/langchainrb/blob/main/CHANGELOG.md
   documentation_uri: https://rubydoc.info/gems/langchainrb
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -790,8 +790,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Build LLM-backed Ruby applications with Ruby's Langchain.rb
 test_files: []