langchainrb 0.18.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f049086ef6cbb25483d360705c216583d30ca17a88e1a286730a00cbc95fa9fd
-  data.tar.gz: '07592ccbf768d32122e98fc2cd79eb17547aa004591a9e0d9af3406bb782523d'
+  metadata.gz: 6c33b1ac19c1cf4a3a7de8fbf5d2568899d05662cb7db0b96321186c255ef312
+  data.tar.gz: 96bad2ff6f9b9a9cbac26699b525a8646482a0a77131d58fed84de3bafcb074e
 SHA512:
-  metadata.gz: 32b1bd7ab1d86c3615ba1019476011031eb25429a2ff7d4ad0b3efb65ea04967fac668f9c92ea5a5f9e641ebf0b3bb638ec99a1883b6ef7ba8ddf807245c8ca4
-  data.tar.gz: 67be74a35f8a4cc4a5ddd98f40f2e16d179f3127015ec8895f7764e0a1adafa2ac6a02c8493addd0468c04ee4c944cf08fbb3952512a87a05a5d368240d9d924
+  metadata.gz: aef30f32cfbdba307372ab8b20a0a484d22bd72f68d614056c6abb016b16dbd5e7a51dc15fb26746fd7a88a429d6282848aace42076c41e4fb31d58be9fb27f6
+  data.tar.gz: 3fd751a81f1121209ae2fac6bd25bb2e9d524b23dd5afe83967e10a78521e6994b7ca855e7e4343dded1117c5a7377d26cf15607f16247e9f220a27d17b91827

data/CHANGELOG.md

@@ -1,5 +1,35 @@
+# CHANGELOG
+
+## Key
+- [BREAKING]: A breaking change. After an upgrade, your app may need modifications to keep working correctly.
+- [FEATURE]: A non-breaking improvement to the app. Either introduces new functionality, or improves on an existing feature.
+- [BUGFIX]: Fixes a bug with a non-breaking change.
+- [COMPAT]: Compatibility improvements - changes to make Langchain.rb more compatible with different dependency versions.
+- [OPTIM]: Optimization or performance increase.
+- [DOCS]: Documentation changes. No changes to the library's behavior.
+- [SECURITY]: A change which fixes a security vulnerability.
+
 ## [Unreleased]
 
+## [0.19.1] - 2024-11-21
+- [FEATURE] [https://github.com/patterns-ai-core/langchainrb/pull/858] Assistant, when using Anthropic, now also accepts image_url in the message.
+- [FEATURE] [https://github.com/patterns-ai-core/langchainrb/pull/861] Clean up passing `max_tokens` to Anthropic constructor and chat method
+- [FEATURE] [https://github.com/patterns-ai-core/langchainrb/pull/849] Langchain::Assistant now works with AWS Bedrock-hosted Anthropic models
+- [OPTIM] [https://github.com/patterns-ai-core/langchainrb/pull/867] Refactor `GoogleGeminiMessage#to_hash` and `OpenAIMessage#to_hash` methods.
+- [OPTIM] [https://github.com/patterns-ai-core/langchainrb/pull/849] Simplify Langchain::LLM::AwsBedrock class
+- [BUGFIX] [https://github.com/patterns-ai-core/langchainrb/pull/869] AnthropicMessage now correctly handles tool calls with content.
+- [OPTIM] [https://github.com/patterns-ai-core/langchainrb/pull/870] Assistant, when using Ollama (e.g.: llava model), now also accepts image_url in the message.
+
+## [0.19.0] - 2024-10-23
+- [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/840] Rename `chat_completion_model_name` parameter to `chat_model` in Langchain::LLM parameters.
+- [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/840] Rename `completion_model_name` parameter to `completion_model` in Langchain::LLM parameters.
+- [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/840] Rename `embeddings_model_name` parameter to `embedding_model` in Langchain::LLM parameters.
+- [BUGFIX] [https://github.com/patterns-ai-core/langchainrb/pull/850/] Fix MistralAIMessage to handle "Tool" Output
+- [BUGFIX] [https://github.com/patterns-ai-core/langchainrb/pull/837] Fix bug when tool functions with no input variables are used with Langchain::LLM::Anthropic
+- [BUGFIX] [https://github.com/patterns-ai-core/langchainrb/pull/836] Fix bug when assistant.instructions = nil did not remove the system message
+- [FEATURE] [https://github.com/patterns-ai-core/langchainrb/pull/838] Allow setting safety_settings: [] in default_options for Langchain::LLM::GoogleGemini and Langchain::LLM::GoogleVertexAI constructors
+- [BUGFIX] [https://github.com/patterns-ai-core/langchainrb/pull/871] Allow passing in options hash to Ollama
+
 ## [0.18.0] - 2024-10-12
 - [BREAKING] Remove `Langchain::Assistant#clear_thread!` method
 - [BREAKING] `Langchain::Messages::*` namespace had migrated to `Langchain::Assistant::Messages::*`

data/README.md

@@ -86,7 +86,7 @@ Most LLM classes can be initialized with an API key and optional default options
 ```ruby
 llm = Langchain::LLM::OpenAI.new(
   api_key: ENV["OPENAI_API_KEY"],
-  default_options: { temperature: 0.7, chat_completion_model_name: "gpt-4o" }
+  default_options: { temperature: 0.7, chat_model: "gpt-4o" }
 )
 ```
 
@@ -133,7 +133,7 @@ messages = [
   { role: "system", content: "You are a helpful assistant." },
   { role: "user", content: "What's the weather like today?" }
   # Google Gemini and Google VertexAI expect messages in a different format:
-  # { role: "user", parts: [{ text: "why is the sky blue?" }]
+  # { role: "user", parts: [{ text: "why is the sky blue?" }]}
 ]
 response = llm.chat(messages: messages)
 chat_completion = response.chat_completion
@@ -505,7 +505,7 @@ assistant.add_message_and_run!(content: "What's the latest news about AI?")
 # Supply an image to the assistant
 assistant.add_message_and_run!(
   content: "Show me a picture of a cat",
-  image: "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"
+  image_url: "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"
 )
 
 # Access the conversation thread
@@ -558,7 +558,7 @@ Note that streaming is not currently supported for all LLMs.
 The Langchain::Assistant can be easily extended with custom tools by creating classes that `extend Langchain::ToolDefinition` module and implement required methods.
 ```ruby
 class MovieInfoTool
-  include Langchain::ToolDefinition
+  extend Langchain::ToolDefinition
 
   define_function :search_movie, description: "MovieInfoTool: Search for a movie by title" do
     property :query, type: "string", description: "The movie title to search for", required: true

data/lib/langchain/assistant/llm/adapter.rb

@@ -6,16 +6,17 @@ module Langchain
       # TODO: Fix the message truncation when context window is exceeded
       class Adapter
         def self.build(llm)
-          case llm
-          when Langchain::LLM::Anthropic
+          if llm.is_a?(Langchain::LLM::Anthropic)
             LLM::Adapters::Anthropic.new
-          when Langchain::LLM::GoogleGemini, Langchain::LLM::GoogleVertexAI
+          elsif llm.is_a?(Langchain::LLM::AwsBedrock) && llm.defaults[:chat_model].include?("anthropic")
+            LLM::Adapters::AwsBedrockAnthropic.new
+          elsif llm.is_a?(Langchain::LLM::GoogleGemini) || llm.is_a?(Langchain::LLM::GoogleVertexAI)
             LLM::Adapters::GoogleGemini.new
-          when Langchain::LLM::MistralAI
+          elsif llm.is_a?(Langchain::LLM::MistralAI)
             LLM::Adapters::MistralAI.new
-          when Langchain::LLM::Ollama
+          elsif llm.is_a?(Langchain::LLM::Ollama)
             LLM::Adapters::Ollama.new
-          when Langchain::LLM::OpenAI
+          elsif llm.is_a?(Langchain::LLM::OpenAI)
             LLM::Adapters::OpenAI.new
           else
             raise ArgumentError, "Unsupported LLM type: #{llm.class}"

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

@@ -38,9 +38,7 @@ module Langchain
           # @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)
-            Langchain.logger.warn "WARNING: Image URL is not supported by Anthropic currently" if image_url
-
-            Messages::AnthropicMessage.new(role: role, content: content, tool_calls: tool_calls, tool_call_id: tool_call_id)
+            Messages::AnthropicMessage.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 Anthropic tool call hash

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Langchain
+  class Assistant
+    module LLM
+      module Adapters
+        class AwsBedrockAnthropic < Anthropic
+          private
+
+          # @param [String] choice
+          # @param [Boolean] _parallel_tool_calls
+          # @return [Hash]
+          def build_tool_choice(choice, _parallel_tool_calls)
+            # Aws Bedrock hosted Anthropic does not support parallel tool calls
+            Langchain.logger.warn "WARNING: parallel_tool_calls is not supported by AWS Bedrock Anthropic currently"
+
+            tool_choice_object = {}
+
+            case choice
+            when "auto"
+              tool_choice_object[:type] = "auto"
+            when "any"
+              tool_choice_object[:type] = "any"
+            else
+              tool_choice_object[:type] = "tool"
+              tool_choice_object[:name] = choice
+            end
+
+            tool_choice_object
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -39,9 +39,7 @@ module Langchain
           # @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)
-            Langchain.logger.warn "WARNING: Image URL is not supported by Ollama currently" if image_url
-
-            Messages::OllamaMessage.new(role: role, content: content, tool_calls: tool_calls, tool_call_id: tool_call_id)
+            Messages::OllamaMessage.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

data/lib/langchain/assistant/messages/anthropic_message.rb

@@ -12,13 +12,26 @@ module Langchain
 
         TOOL_ROLE = "tool_result"
 
-        def initialize(role:, content: nil, tool_calls: [], tool_call_id: nil)
+        # Initialize a new Anthropic message
+        #
+        # @param role [String] The role of the message
+        # @param content [String] The content of the message
+        # @param tool_calls [Array<Hash>] The tool calls made in the message
+        # @param tool_call_id [String] The ID of the tool call
+        def initialize(
+          role:,
+          content: nil,
+          image_url: nil,
+          tool_calls: [],
+          tool_call_id: nil
+        )
           raise ArgumentError, "Role must be one of #{ROLES.join(", ")}" unless ROLES.include?(role)
           raise ArgumentError, "Tool calls must be an array of hashes" unless tool_calls.is_a?(Array) && tool_calls.all? { |tool_call| tool_call.is_a?(Hash) }
 
           @role = role
           # Some Tools return content as a JSON hence `.to_s`
           @content = content.to_s
+          @image_url = image_url
           @tool_calls = tool_calls
           @tool_call_id = tool_call_id
         end
@@ -27,23 +40,82 @@ module Langchain
         #
         # @return [Hash] The message as an Anthropic API-compatible hash
         def to_hash
-          {}.tap do |h|
-            h[:role] = tool? ? "user" : role
-
-            h[:content] = if tool?
-              [
-                {
-                  type: "tool_result",
-                  tool_use_id: tool_call_id,
-                  content: content
-                }
-              ]
-            elsif tool_calls.any?
-              tool_calls
-            else
-              content
-            end
+          if assistant?
+            assistant_hash
+          elsif tool?
+            tool_hash
+          elsif user?
+            user_hash
+          end
+        end
+
+        # Convert the message to an Anthropic API-compatible hash
+        #
+        # @return [Hash] The message as an Anthropic API-compatible hash, with the role as "assistant"
+        def assistant_hash
+          {
+            role: "assistant",
+            content: [
+              {
+                type: "text",
+                text: content
+              }
+            ].concat(tool_calls)
+          }
+        end
+
+        # Convert the message to an Anthropic API-compatible hash
+        #
+        # @return [Hash] The message as an Anthropic API-compatible hash, with the role as "user"
+        def tool_hash
+          {
+            role: "user",
+            # TODO: Tool can also return images
+            # https://docs.anthropic.com/en/docs/build-with-claude/tool-use#handling-tool-use-and-tool-result-content-blocks
+            content: [
+              {
+                type: "tool_result",
+                tool_use_id: tool_call_id,
+                content: content
+              }
+            ]
+          }
+        end
+
+        # Convert the message to an Anthropic API-compatible hash
+        #
+        # @return [Hash] The message as an Anthropic API-compatible hash, with the role as "user"
+        def user_hash
+          {
+            role: "user",
+            content: build_content_array
+          }
+        end
+
+        # Builds the content value for the message hash
+        # @return [Array<Hash>] An array of content hashes
+        def build_content_array
+          content_details = []
+
+          if content && !content.empty?
+            content_details << {
+              type: "text",
+              text: content
+            }
           end
+
+          if image
+            content_details << {
+              type: "image",
+              source: {
+                type: "base64",
+                data: image.base64,
+                media_type: image.mime_type
+              }
+            }
+          end
+
+          content_details
         end
 
         # Check if the message is a tool call

data/lib/langchain/assistant/messages/base.rb

@@ -50,6 +50,10 @@ module Langchain
           # TODO: Should we return :unknown or raise an error?
           :unknown
         end
+
+        def image
+          image_url ? Utils::ImageWrapper.new(image_url) : nil
+        end
       end
     end
   end

data/lib/langchain/assistant/messages/google_gemini_message.rb

@@ -15,10 +15,10 @@ module Langchain
 
         # Initialize a new Google Gemini message
         #
-        # @param [String] The role of the message
-        # @param [String] The content of the message
-        # @param [Array<Hash>] The tool calls made in the message
-        # @param [String] The ID of the tool call
+        # @param role [String] The role of the message
+        # @param content [String] The content of the message
+        # @param tool_calls [Array<Hash>] The tool calls made in the message
+        # @param tool_call_id [String] The ID of the tool call
         def initialize(role:, content: nil, tool_calls: [], tool_call_id: nil)
           raise ArgumentError, "Role must be one of #{ROLES.join(", ")}" unless ROLES.include?(role)
           raise ArgumentError, "Tool calls must be an array of hashes" unless tool_calls.is_a?(Array) && tool_calls.all? { |tool_call| tool_call.is_a?(Hash) }
@@ -41,23 +41,12 @@ module Langchain
         #
         # @return [Hash] The message as a Google Gemini API-compatible hash
         def to_hash
-          {}.tap do |h|
-            h[:role] = role
-            h[:parts] = if function?
-              [{
-                functionResponse: {
-                  name: tool_call_id,
-                  response: {
-                    name: tool_call_id,
-                    content: content
-                  }
-                }
-              }]
-            elsif tool_calls.any?
-              tool_calls
-            else
-              [{text: content}]
-            end
+          if tool?
+            tool_hash
+          elsif model?
+            model_hash
+          elsif user?
+            user_hash
           end
         end
 
@@ -73,6 +62,13 @@ module Langchain
           function?
         end
 
+        # Check if the message is a user call
+        #
+        # @return [Boolean] true/false whether this message is a user call
+        def user?
+          role == "user"
+        end
+
         # Check if the message is a tool call
         #
         # @return [Boolean] true/false whether this message is a tool call
@@ -80,6 +76,51 @@ module Langchain
           role == "function"
         end
 
+        # Convert the message to an GoogleGemini API-compatible hash
+        # @return [Hash] The message as an GoogleGemini API-compatible hash, with the role as "model"
+        def model_hash
+          {
+            role: role,
+            parts: build_parts
+          }
+        end
+
+        # Convert the message to an GoogleGemini API-compatible hash
+        # @return [Hash] The message as an GoogleGemini API-compatible hash, with the role as "function"
+        def tool_hash
+          {
+            role: role,
+            parts: [{
+              functionResponse: {
+                name: tool_call_id,
+                response: {
+                  name: tool_call_id,
+                  content: content
+                }
+              }
+            }]
+          }
+        end
+
+        # Convert the message to an GoogleGemini API-compatible hash
+        # @return [Hash] The message as an GoogleGemini API-compatible hash, with the role as "user"
+        def user_hash
+          {
+            role: role,
+            parts: build_parts
+          }
+        end
+
+        # Builds the part value for the message hash
+        # @return [Array<Hash>] An array of content hashes of the text or of the tool calls if present
+        def build_parts
+          if tool_calls.any?
+            tool_calls
+          else
+            [{text: content}]
+          end
+        end
+
         # Check if the message came from an LLM
         #
         # @return [Boolean] true/false whether this message was produced by an LLM

data/lib/langchain/assistant/messages/mistral_ai_message.rb

@@ -45,30 +45,14 @@ module Langchain
         #
         # @return [Hash] The message as an MistralAI API-compatible hash
         def to_hash
-          {}.tap do |h|
-            h[:role] = role
-
-            if tool_calls.any?
-              h[:tool_calls] = tool_calls
-            else
-              h[:tool_call_id] = tool_call_id if tool_call_id
-
-              h[:content] = []
-
-              if content && !content.empty?
-                h[:content] << {
-                  type: "text",
-                  text: content
-                }
-              end
-
-              if image_url
-                h[:content] << {
-                  type: "image_url",
-                  image_url: image_url
-                }
-              end
-            end
+          if assistant?
+            assistant_hash
+          elsif system?
+            system_hash
+          elsif tool?
+            tool_hash
+          elsif user?
+            user_hash
           end
         end
 
@@ -92,6 +76,67 @@ module Langchain
         def tool?
           role == "tool"
         end
+
+        # Convert the message to an MistralAI API-compatible hash
+        # @return [Hash] The message as an MistralAI API-compatible hash, with the role as "assistant"
+        def assistant_hash
+          {
+            role: "assistant",
+            content: content,
+            tool_calls: tool_calls,
+            prefix: false
+          }
+        end
+
+        # Convert the message to an MistralAI API-compatible hash
+        # @return [Hash] The message as an MistralAI API-compatible hash, with the role as "system"
+        def system_hash
+          {
+            role: "system",
+            content: build_content_array
+          }
+        end
+
+        # Convert the message to an MistralAI API-compatible hash
+        # @return [Hash] The message as an MistralAI API-compatible hash, with the role as "tool"
+        def tool_hash
+          {
+            role: "tool",
+            content: content,
+            tool_call_id: tool_call_id
+          }
+        end
+
+        # Convert the message to an MistralAI API-compatible hash
+        # @return [Hash] The message as an MistralAI API-compatible hash, with the role as "user"
+        def user_hash
+          {
+            role: "user",
+            content: build_content_array
+          }
+        end
+
+        # Builds the content value for the message hash
+        # @return [Array<Hash>] An array of content hashes, with keys :type and :text or :image_url.
+        def build_content_array
+          content_details = []
+
+          if content && !content.empty?
+            content_details << {
+              type: "text",
+              text: content
+            }
+          end
+
+          if image_url
+            content_details << {
+              type: "image_url",
+              image_url: image_url
+            }
+          end
+
+          content_details
+        end
       end
     end
   end

data/lib/langchain/assistant/messages/ollama_message.rb

@@ -16,17 +16,20 @@ module Langchain
 
         # Initialize a new OpenAI message
         #
-        # @param [String] The role of the message
-        # @param [String] The content of the message
-        # @param [Array<Hash>] The tool calls made in the message
-        # @param [String] The ID of the tool call
-        def initialize(role:, content: nil, tool_calls: [], tool_call_id: nil)
+        # @param role [String] The role of the message
+        # @param content [String] The content of the message
+        # @param image_url [String] The URL of the image to include in the message
+        # @param tool_calls [Array<Hash>] The tool calls made in the message
+        # @param tool_call_id [String] The ID of the tool call
+        def initialize(role:, content: nil, image_url: nil, tool_calls: [], tool_call_id: nil)
           raise ArgumentError, "Role must be one of #{ROLES.join(", ")}" unless ROLES.include?(role)
           raise ArgumentError, "Tool calls must be an array of hashes" unless tool_calls.is_a?(Array) && tool_calls.all? { |tool_call| tool_call.is_a?(Hash) }
+          raise ArgumentError, "image_url must be a valid url" if image_url && !URI::DEFAULT_PARSER.make_regexp.match?(image_url)
 
           @role = role
           # Some Tools return content as a JSON hence `.to_s`
           @content = content.to_s
+          @image_url = image_url
           @tool_calls = tool_calls
           @tool_call_id = tool_call_id
         end
@@ -38,6 +41,7 @@ module Langchain
           {}.tap do |h|
             h[:role] = role
             h[:content] = content if content # Content is nil for tool calls
+            h[:images] = [image.base64] if image
             h[:tool_calls] = tool_calls if tool_calls.any?
             h[:tool_call_id] = tool_call_id if tool_call_id
           end