langchainrb 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce8728ec2208577809174e154642db161121cb9dd49e0ec5d190d080e68b1d78
-  data.tar.gz: bb0e0ccc4558ca849549f495a4adfacc5f7851c786869974afdaef29f0cde3ca
+  metadata.gz: e6e84f50b6e12bd94f5fa8de956549537f5d34b8a901bc6af3fbc5d392fc2e0a
+  data.tar.gz: '08c01f481d64b0c35f7e86491d1115d975497c8561f50408516fad388f084c3e'
 SHA512:
-  metadata.gz: b2b4c27e31d730563aeca70a0aa3c4cf129e69773e34f397ba057faa8298a4368c1b9f66f925188f867f1feb47b4e07f77df702fa7c6cb76ad1e1a8464b895f6
-  data.tar.gz: 55dd3fbc21e2cdf9bd84afcd6bb4de0f72c960dec0c6b1d2efff1f9492b3d5c7399f2d14c323597045e64eafb6f2f20992348d640317c64721fb0556f8a64126
+  metadata.gz: 8a1d29180f3c0cf89307413bc99e22accc6875d458b3ae12ea72d30146cf5ff172fba7047fe00b385d324057638115254c8dcc6f01459a75f96dccb9a99a301b
+  data.tar.gz: 070a0b6836cdb7dd356c99186964f61926498d5f585910bbb30449d4b2a12d50797797dc34c6fe3eb6a4e64c156230d23606c2ac0cf131eeccc942c6231ab3c9

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.4.2] - 2023-06-03
+- 🗣️ LLMs
+  - Introducing support for AI21
+- Better docs generation
+- Refactors
+
+## [0.4.1] - 2023-06-02
+- Beautiful colored log messages
+- 🛠️ Tools
+  - Introducing `Langchain::Tool::RubyCodeInterpreter`, a tool executes sandboxed Ruby code
+
 ## [0.4.0] - 2023-06-01
 - [BREAKING] Everything is namespaced under `Langchain::` now
 - Pgvector similarity search uses the cosine distance by default now

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    langchainrb (0.4.0)
+    langchainrb (0.4.2)
+      colorize (~> 0.8.1)
       tiktoken_ruby (~> 0.0.5)
 
 GEM
@@ -29,9 +30,11 @@ GEM
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     afm (0.2.2)
+    ai21 (0.2.0)
     ast (2.4.2)
     builder (3.2.4)
     byebug (11.1.3)
+    childprocess (4.1.0)
     chroma-db (0.3.0)
       dry-monads (~> 1.6)
       ruby-next-core (>= 0.15.0)
@@ -39,6 +42,7 @@ GEM
     cohere-ruby (0.9.4)
       faraday (>= 1.0.0)
       faraday_middleware (>= 1.0.0)
+    colorize (0.8.1)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
     diff-lcs (1.5.0)
@@ -207,6 +211,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     rb_sys (0.9.78)
+    rdiscount (2.2.7)
     regexp_parser (2.8.0)
     replicate-ruby (0.2.2)
       addressable
@@ -250,6 +255,8 @@ GEM
     ruby-rc4 (0.1.5)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
+    safe_ruby (1.0.4)
+      childprocess (>= 0.3.9)
     standard (1.28.2)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
@@ -281,6 +288,7 @@ GEM
       graphlient (~> 0.6.0)
     wikipedia-client (1.17.0)
       addressable (~> 2.7)
+    yard (0.9.34)
     zeitwerk (2.6.8)
 
 PLATFORMS
@@ -292,6 +300,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  ai21 (~> 0.2.0)
   chroma-db (~> 0.3.0)
   cohere-ruby (~> 0.9.4)
   docx (~> 0.8.0)
@@ -310,12 +319,15 @@ DEPENDENCIES
   pry-byebug (~> 3.10.0)
   qdrant-ruby (~> 0.9.0)
   rake (~> 13.0)
+  rdiscount
   replicate-ruby (~> 0.2.2)
   rspec (~> 3.0)
   ruby-openai (~> 4.0.0)
+  safe_ruby (~> 1.0.4)
   standardrb
   weaviate-ruby (~> 0.8.0)
   wikipedia-client (~> 1.17.0)
+  yard
 
 BUNDLED WITH
    2.4.0

data/README.md

@@ -109,6 +109,10 @@ Add `gem "ruby-openai", "~> 4.0.0"` to your Gemfile.
 ```ruby
 openai = Langchain::LLM::OpenAI.new(api_key: ENV["OPENAI_API_KEY"])
 ```
+You can pass additional parameters to the constructor, it will be passed to the OpenAI client:
+```ruby
+openai = Langchain::LLM::OpenAI.new(api_key: ENV["OPENAI_API_KEY"], llm_options: {uri_base: "http://localhost:1234"}) )
+```
 ```ruby
 openai.embed(text: "foo bar")
 ```
@@ -260,10 +264,10 @@ agent.run(question: "How many full soccer fields would be needed to cover the di
 | Name         | Description                                        | ENV Requirements                                              | Gem Requirements                          |
 | ------------ | :------------------------------------------------: | :-----------------------------------------------------------: | :---------------------------------------: |
 | "calculator" | Useful for getting the result of a math expression |                                                               | `gem "eqn", "~> 1.6.5"`                   |
-| "search"     | A wrapper around Google Search                     | `ENV["SERPAPI_API_KEY"]` (https://serpapi.com/manage-api-key) | `gem "google_search_results", "~> 2.0.0"` |                      |
+| "ruby_code_interpreter" | Interprets Ruby expressions             |                                                               | `gem "safe_ruby", "~> 1.0.4"`             |
+| "search"     | A wrapper around Google Search                     | `ENV["SERPAPI_API_KEY"]` (https://serpapi.com/manage-api-key) | `gem "google_search_results", "~> 2.0.0"` |
 | "wikipedia"  | Calls Wikipedia API to retrieve the summary        |                                                               | `gem "wikipedia-client", "~> 1.17.0"`     |
 
-
 #### Loaders 🚚
 
 Need to read data from various sources? Load it up.
@@ -300,7 +304,7 @@ Additional examples available: [/examples](https://github.com/andreibondarev/lan
 
 ## Logging
 
-LangChain.rb uses standard logging mechanisms and defaults to `:debug` level. Most messages are at info level, but we will add debug or warn statements as needed.
+LangChain.rb uses standard logging mechanisms and defaults to `:warn` level. Most messages are at info level, but we will add debug or warn statements as needed.
 To show all log messages:
 
 ```ruby
@@ -314,6 +318,9 @@ Langchain.logger.level = :info
 3. `bundle exec rake` to ensure that the tests pass and to run standardrb
 4. `bin/console` to load the gem in a REPL session. Feel free to add your own instances of LLMs, Tools, Agents, etc. and experiment with them.
 
+## Community
+Join us in the [Ruby AI Builders](https://discord.gg/SBmjAnKT) Discord community in #langchainrb
+
 ## Core Contributors
 [<img style="border-radius:50%" alt="Andrei Bondarev" src="https://avatars.githubusercontent.com/u/541665?v=4" width="80" height="80" class="avatar">](https://github.com/andreibondarev)
 

data/Rakefile

@@ -3,6 +3,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "standard/rake"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -11,3 +12,7 @@ task default: :spec
 Rake::Task["spec"].enhance do
   Rake::Task["standard:fix"].invoke
 end
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = ["--fail-on-warning"]
+end

data/lib/langchain/agent/chain_of_thought_agent/chain_of_thought_agent.rb

@@ -42,7 +42,7 @@ module Langchain::Agent
       )
 
       loop do
-        Langchain.logger.info("Agent: Passing the prompt to the #{llm} LLM")
+        Langchain.logger.info("[#{self.class.name}]".red + ": Sending the prompt to the #{llm} LLM")
         response = llm_client.complete(
           prompt: prompt,
           stop_sequences: ["Observation:"],
@@ -59,12 +59,11 @@ module Langchain::Agent
           # Find the input to the action in the "Action Input: [action_input]" format
           action_input = response.match(/Action Input: "?(.*)"?/)&.send(:[], -1)
 
-          Langchain.logger.info("Agent: Using the \"#{action}\" Tool with \"#{action_input}\"")
-
           # Retrieve the Tool::[ToolName] class and call `execute`` with action_input as the input
-          result = Langchain::Tool
-            .const_get(Langchain::Tool::Base::TOOLS[action.strip])
-            .execute(input: action_input)
+          tool = Langchain::Tool.const_get(Langchain::Tool::Base::TOOLS[action.strip])
+          Langchain.logger.info("[#{self.class.name}]".red + ": Invoking \"#{tool}\" Tool with \"#{action_input}\"")
+
+          result = tool.execute(input: action_input)
 
           # Append the Observation to the prompt
           prompt += if prompt.end_with?("Observation:")

data/lib/langchain/dependency_helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Langchain
+  module DependencyHelper
+    class VersionError < ScriptError; end
+
+    # This method requires and loads the given gem, and then checks to see if the version of the gem meets the requirements listed in `langchain.gemspec`
+    # This solution was built to avoid auto-loading every single gem in the Gemfile when the developer will mostly likely be only using a few of them.
+    #
+    # @param gem_name [String] The name of the gem to load
+    # @return [Boolean] Whether or not the gem was loaded successfully
+    # @raise [LoadError] If the gem is not installed
+    # @raise [VersionError] If the gem is installed, but the version does not meet the requirements
+    #
+    def depends_on(gem_name)
+      gem(gem_name) # require the gem
+
+      return(true) unless defined?(Bundler) # If we're in a non-bundler environment, we're no longer able to determine if we'll meet requirements
+
+      gem_version = Gem.loaded_specs[gem_name].version
+      gem_requirement = Bundler.load.dependencies.find { |g| g.name == gem_name }&.requirement
+
+      raise LoadError unless gem_requirement
+
+      unless gem_requirement.satisfied_by?(gem_version)
+        raise VersionError, "The #{gem_name} gem is installed, but version #{gem_requirement} is required. You have #{gem_version}."
+      end
+
+      true
+    rescue LoadError
+      raise LoadError, "Could not load #{gem_name}. Please ensure that the #{gem_name} gem is installed."
+    end
+  end
+end

data/lib/langchain/llm/ai21.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Langchain::LLM
+  class AI21 < Base
+    #
+    # Wrapper around AI21 Studio APIs.
+    #
+    # Gem requirements: gem "ai21", "~> 0.2.0"
+    #
+    # Usage:
+    # ai21 = Langchain::LLM::AI21.new(api_key:)
+    #
+
+    def initialize(api_key:)
+      depends_on "ai21"
+      require "ai21"
+
+      @client = ::AI21::Client.new(api_key)
+    end
+
+    #
+    # Generate a completion for a given prompt
+    #
+    # @param prompt [String] The prompt to generate a completion for
+    # @param params [Hash] The parameters to pass to the API
+    # @return [String] The completion
+    #
+    def complete(prompt:, **params)
+      response = client.complete(prompt, params)
+      response.dig(:completions, 0, :data, :text)
+    end
+
+    #
+    # Generate a summary for a given text
+    #
+    # @param text [String] The text to generate a summary for
+    # @param params [Hash] The parameters to pass to the API
+    # @return [String] The summary
+    #
+    def summarize(text:, **params)
+      response = client.summarize(text, "TEXT", params)
+      response.dig(:summary)
+    end
+  end
+end

data/lib/langchain/llm/base.rb

@@ -2,10 +2,11 @@
 
 module Langchain::LLM
   class Base
+    include Langchain::DependencyHelper
+
     attr_reader :client
 
     # Currently supported LLMs
-    # TODO: Add support for HuggingFace and other LLMs
     LLMS = {
       cohere: "Cohere",
       google_palm: "GooglePalm",

data/lib/langchain/llm/cohere.rb

@@ -2,6 +2,15 @@
 
 module Langchain::LLM
   class Cohere < Base
+    #
+    # Wrapper around the Cohere API.
+    #
+    # Gem requirements: gem "cohere-ruby", "~> 0.9.4"
+    #
+    # Usage:
+    # cohere = Langchain::LLM::Cohere.new(api_key: "YOUR_API_KEY")
+    #
+
     DEFAULTS = {
       temperature: 0.0,
       completion_model_name: "base",

data/lib/langchain/llm/google_palm.rb

@@ -2,7 +2,14 @@
 
 module Langchain::LLM
   class GooglePalm < Base
+    #
     # Wrapper around the Google PaLM (Pathways Language Model) APIs.
+    #
+    # Gem requirements: gem "google_palm_api", "~> 0.1.0"
+    #
+    # Usage:
+    # google_palm = Langchain::LLM::GooglePalm.new(api_key: "YOUR_API_KEY")
+    #
 
     DEFAULTS = {
       temperature: 0.0,

data/lib/langchain/llm/hugging_face.rb

@@ -2,6 +2,15 @@
 
 module Langchain::LLM
   class HuggingFace < Base
+    #
+    # Wrapper around the HuggingFace Inference API.
+    #
+    # Gem requirements: gem "hugging-face", "~> 0.3.4"
+    #
+    # Usage:
+    # hf = Langchain::LLM::HuggingFace.new(api_key: "YOUR_API_KEY")
+    #
+
     # The gem does not currently accept other models:
     # https://github.com/alchaplinsky/hugging-face/blob/main/lib/hugging_face/inference_api.rb#L32-L34
     DEFAULTS = {

data/lib/langchain/llm/openai.rb

@@ -2,6 +2,15 @@
 
 module Langchain::LLM
   class OpenAI < Base
+    #
+    # Wrapper around OpenAI APIs.
+    #
+    # Gem requirements: gem "ruby-openai", "~> 4.0.0"
+    #
+    # Usage:
+    # openai = Langchain::LLM::OpenAI.new(api_key:, llm_options: {})
+    #
+
     DEFAULTS = {
       temperature: 0.0,
       completion_model_name: "text-davinci-003",
@@ -10,12 +19,11 @@ module Langchain::LLM
       dimension: 1536
     }.freeze
 
-    def initialize(api_key:)
+    def initialize(api_key:, llm_options: {})
       depends_on "ruby-openai"
       require "openai"
 
-      # TODO: Add support to pass `organization_id:`
-      @client = ::OpenAI::Client.new(access_token: api_key)
+      @client = ::OpenAI::Client.new(access_token: api_key, **llm_options)
     end
 
     #
@@ -24,17 +32,12 @@ module Langchain::LLM
     # @param text [String] The text to generate an embedding for
     # @return [Array] The embedding
     #
-    def embed(text:)
-      model = DEFAULTS[:embeddings_model_name]
+    def embed(text:, **params)
+      parameters = {model: DEFAULTS[:embeddings_model_name], input: text}
 
-      Langchain::Utils::TokenLengthValidator.validate!(text, model)
+      Langchain::Utils::TokenLengthValidator.validate!(text, parameters[:model])
 
-      response = client.embeddings(
-        parameters: {
-          model: model,
-          input: text
-        }
-      )
+      response = client.embeddings(parameters: parameters.merge(params))
       response.dig("data").first.dig("embedding")
     end
 
@@ -45,23 +48,13 @@ module Langchain::LLM
     # @return [String] The completion
     #
     def complete(prompt:, **params)
-      model = DEFAULTS[:completion_model_name]
-
-      Langchain::Utils::TokenLengthValidator.validate!(prompt, model)
-
-      default_params = {
-        model: model,
-        temperature: DEFAULTS[:temperature],
-        prompt: prompt
-      }
+      parameters = compose_parameters DEFAULTS[:completion_model_name], params
 
-      if params[:stop_sequences]
-        default_params[:stop] = params.delete(:stop_sequences)
-      end
+      Langchain::Utils::TokenLengthValidator.validate!(prompt, parameters[:model])
 
-      default_params.merge!(params)
+      parameters[:prompt] = prompt
 
-      response = client.completions(parameters: default_params)
+      response = client.completions(parameters: parameters)
       response.dig("choices", 0, "text")
     end
 
@@ -72,24 +65,13 @@ module Langchain::LLM
     # @return [String] The chat completion
     #
     def chat(prompt:, **params)
-      model = DEFAULTS[:chat_completion_model_name]
+      parameters = compose_parameters DEFAULTS[:chat_completion_model_name], params
 
-      Langchain::Utils::TokenLengthValidator.validate!(prompt, model)
+      Langchain::Utils::TokenLengthValidator.validate!(prompt, parameters[:model])
 
-      default_params = {
-        model: model,
-        temperature: DEFAULTS[:temperature],
-        # TODO: Figure out how to introduce persisted conversations
-        messages: [{role: "user", content: prompt}]
-      }
-
-      if params[:stop_sequences]
-        default_params[:stop] = params.delete(:stop_sequences)
-      end
+      parameters[:messages] = [{role: "user", content: prompt}]
 
-      default_params.merge!(params)
-
-      response = client.chat(parameters: default_params)
+      response = client.chat(parameters: parameters)
       response.dig("choices", 0, "message", "content")
     end
 
@@ -112,5 +94,15 @@ module Langchain::LLM
         max_tokens: 2048
       )
     end
+
+    private
+
+    def compose_parameters(model, params)
+      default_params = {model: model, temperature: DEFAULTS[:temperature]}
+
+      default_params[:stop] = params.delete(:stop_sequences) if params[:stop_sequences]
+
+      default_params.merge(params)
+    end
   end
 end

data/lib/langchain/llm/replicate.rb

@@ -2,7 +2,11 @@
 
 module Langchain::LLM
   class Replicate < Base
+    #
     # Wrapper around Replicate.com LLM provider
+    #
+    # Gem requirements: gem "replicate-ruby", "~> 0.2.2"
+    #
     # Use it directly:
     # replicate = LLM::Replicate.new(api_key: ENV["REPLICATE_API_KEY"])
     #

data/lib/langchain/processors/base.rb

@@ -3,6 +3,8 @@
 module Langchain
   module Processors
     class Base
+      include Langchain::DependencyHelper
+
       EXTENSIONS = []
       CONTENT_TYPES = []
 

data/lib/langchain/prompt/base.rb

@@ -64,9 +64,9 @@ module Langchain::Prompt
     #
     # This method takes a template string and returns an array of input variable names
     # contained within the template. Input variables are defined as text enclosed in
-    # curly braces (e.g. "{variable_name}").
+    # curly braces (e.g. <code>\{variable_name\}</code>).
     #
-    # Content within two consecutive curly braces (e.g. "{{ignore_me}}) are ignored.
+    # Content within two consecutive curly braces (e.g. <code>\{\{ignore_me}}</code>) are ignored.
     #
     # @param template [String] The template string to extract variables from.
     #

data/lib/langchain/prompt/loading.rb

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

data/lib/langchain/prompt/prompt_template.rb

@@ -20,7 +20,7 @@ module Langchain::Prompt
     end
 
     #
-    # Format the prompt with the inputs. Double {{}} replaced with single {} to adhere to f-string spec.
+    # Format the prompt with the inputs. Double <code>{{}}</code> replaced with single <code>{}</code> to adhere to f-string spec.
     #
     # @param kwargs [Hash] Any arguments to be passed to the prompt template.
     # @return [String] A formatted string.

data/lib/langchain/tool/base.rb

@@ -2,6 +2,8 @@
 
 module Langchain::Tool
   class Base
+    include Langchain::DependencyHelper
+
     # How to add additional Tools?
     # 1. Create a new file in lib/tool/your_tool_name.rb
     # 2. Add your tool to the TOOLS hash below

data/lib/langchain/tool/calculator.rb

@@ -2,6 +2,15 @@
 
 module Langchain::Tool
   class Calculator < Base
+    #
+    # A calculator tool that falls back to the Google calculator widget
+    #
+    # Gem requirements:
+    #   gem "eqn", "~> 1.6.5"
+    #   gem "google_search_results", "~> 2.0.0"
+    # ENV requirements: ENV["SERPAPI_API_KEY"]
+    #
+
     description <<~DESC
       Useful for getting the result of a math expression.
 
@@ -18,6 +27,8 @@ module Langchain::Tool
     # @param input [String] math expression
     # @return [String] Answer
     def execute(input:)
+      Langchain.logger.info("[#{self.class.name}]".light_blue + ": Executing \"#{input}\"")
+
       Eqn::Calculator.calc(input)
     rescue Eqn::ParseError, Eqn::NoVariableValueError
       # Sometimes the input is not a pure math expression, e.g: "12F in Celsius"

data/lib/langchain/tool/ruby_code_interpreter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Langchain::Tool
+  class RubyCodeInterpreter < Base
+    #
+    # A tool that execute Ruby code in a sandboxed environment.
+    #
+    # Gem requirements: gem "safe_ruby", "~> 1.0.4"
+    #
+
+    description <<~DESC
+      A Ruby code interpreter. Use this to execute ruby expressions. Input should be a valid ruby expression. If you want to see the output of the tool, make sure to return a value.
+    DESC
+
+    def initialize(timeout: 30)
+      @timeout = timeout
+      depends_on "safe_ruby"
+      require "safe_ruby"
+    end
+
+    # @param input [String] ruby code expression
+    # @return [String] Answer
+    def execute(input:)
+      Langchain.logger.info("[#{self.class.name}]".light_blue + ": Executing \"#{input}\"")
+
+      safe_eval(input)
+    end
+
+    def safe_eval(code)
+      SafeRuby.eval(code, timeout: @timeout)
+    end
+  end
+end

data/lib/langchain/tool/serp_api.rb

@@ -2,8 +2,12 @@
 
 module Langchain::Tool
   class SerpApi < Base
+    #
     # Wrapper around SerpAPI
-    # Set ENV["SERPAPI_API_KEY"] to use it
+    #
+    # Gem requirements: gem "google_search_results", "~> 2.0.0"
+    # ENV requirements: ENV["SERPAPI_API_KEY"] # https://serpapi.com/manage-api-key)
+    #
 
     description <<~DESC
       A wrapper around Google Search.
@@ -33,6 +37,8 @@ module Langchain::Tool
     # TODO: Glance at all of the fields that langchain Python looks through: https://github.com/hwchase17/langchain/blob/v0.0.166/langchain/utilities/serpapi.py#L128-L156
     # We may need to do the same thing here.
     def execute(input:)
+      Langchain.logger.info("[#{self.class.name}]".light_blue + ": Executing \"#{input}\"")
+
       hash_results = execute_search(input: input)
 
       hash_results.dig(:answer_box, :answer) ||

data/lib/langchain/tool/wikipedia.rb

@@ -2,7 +2,11 @@
 
 module Langchain::Tool
   class Wikipedia < Base
+    #
     # Tool that adds the capability to search using the Wikipedia API
+    #
+    # Gem requirements: gem "wikipedia-client", "~> 1.17.0"
+    #
 
     description <<~DESC
       A wrapper around Wikipedia.
@@ -22,6 +26,8 @@ module Langchain::Tool
     # @param input [String] search query
     # @return [String] Answer
     def execute(input:)
+      Langchain.logger.info("[#{self.class.name}]".light_blue + ": 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

data/lib/langchain/vectorsearch/base.rb

@@ -4,6 +4,7 @@ require "forwardable"
 
 module Langchain::Vectorsearch
   class Base
+    include Langchain::DependencyHelper
     extend Forwardable
 
     attr_reader :client, :index_name, :llm, :llm_api_key, :llm_client

data/lib/langchain/vectorsearch/chroma.rb

@@ -2,6 +2,15 @@
 
 module Langchain::Vectorsearch
   class Chroma < Base
+    #
+    # Wrapper around Chroma DB
+    #
+    # Gem requirements: gem "chroma-db", "~> 0.3.0"
+    #
+    # Usage:
+    # chroma = Langchain::Vectorsearch::Chroma.new(url:, index_name:, llm:, llm_api_key:, api_key: nil)
+    #
+
     # Initialize the Chroma client
     # @param url [String] The URL of the Qdrant server
     # @param api_key [String] The API key to use

data/lib/langchain/vectorsearch/milvus.rb

@@ -2,6 +2,15 @@
 
 module Langchain::Vectorsearch
   class Milvus < Base
+    #
+    # Wrapper around Milvus REST APIs.
+    #
+    # Gem requirements: gem "milvus", "~> 0.9.0"
+    #
+    # Usage:
+    # milvus = Langchain::Vectorsearch::Milvus.new(url:, index_name:, llm:, llm_api_key:)
+    #
+
     def initialize(url:, index_name:, llm:, llm_api_key:, api_key: nil)
       depends_on "milvus"
       require "milvus"

data/lib/langchain/vectorsearch/pgvector.rb

@@ -1,8 +1,16 @@
 # frozen_string_literal: true
 
 module Langchain::Vectorsearch
-  # The PostgreSQL vector search adapter
   class Pgvector < Base
+    #
+    # The PostgreSQL vector search adapter
+    #
+    # Gem requirements: gem "pgvector", "~> 0.2"
+    #
+    # Usage:
+    # pgvector = Langchain::Vectorsearch::Pgvector.new(url:, index_name:, llm:, llm_api_key:)
+    #
+
     # The operators supported by the PostgreSQL vector search adapter
     OPERATORS = {
       "cosine_distance" => "<=>",

data/lib/langchain/vectorsearch/pinecone.rb

@@ -2,6 +2,15 @@
 
 module Langchain::Vectorsearch
   class Pinecone < Base
+    #
+    # Wrapper around Pinecone API.
+    #
+    # Gem requirements: gem "pinecone", "~> 0.1.6"
+    #
+    # Usage:
+    # pinecone = Langchain::Vectorsearch::Pinecone.new(environment:, api_key:, index_name:, llm:, llm_api_key:)
+    #
+
     # Initialize the Pinecone client
     # @param environment [String] The environment to use
     # @param api_key [String] The API key to use

data/lib/langchain/vectorsearch/qdrant.rb

@@ -2,6 +2,15 @@
 
 module Langchain::Vectorsearch
   class Qdrant < Base
+    #
+    # Wrapper around Qdrant
+    #
+    # Gem requirements: gem "qdrant-ruby", "~> 0.9.0"
+    #
+    # Usage:
+    # qdrant = Langchain::Vectorsearch::Qdrant.new(url:, api_key:, index_name:, llm:, llm_api_key:)
+    #
+
     # Initialize the Qdrant client
     # @param url [String] The URL of the Qdrant server
     # @param api_key [String] The API key to use

data/lib/langchain/vectorsearch/weaviate.rb

@@ -2,6 +2,15 @@
 
 module Langchain::Vectorsearch
   class Weaviate < Base
+    #
+    # Wrapper around Weaviate
+    #
+    # Gem requirements: gem "weaviate-ruby", "~> 0.8.0"
+    #
+    # Usage:
+    # weaviate = Langchain::Vectorsearch::Weaviate.new(url:, api_key:, index_name:, llm:, llm_api_key:)
+    #
+
     # Initialize the Weaviate adapter
     # @param url [String] The URL of the Weaviate instance
     # @param api_key [String] The API key to use

data/lib/{version.rb → langchain/version.rb}

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

data/lib/langchain.rb

@@ -2,9 +2,9 @@
 
 require "logger"
 require "pathname"
+require "colorize"
 
-require_relative "./version"
-require_relative "./dependency_helper"
+require_relative "./langchain/version"
 
 module Langchain
   class << self
@@ -13,12 +13,13 @@ module Langchain
     attr_reader :root
   end
 
-  @logger ||= ::Logger.new($stdout, level: :warn, formatter: ->(severity, datetime, progname, msg) { "[LangChain.rb] #{msg}\n" })
+  @logger ||= ::Logger.new($stdout, level: :warn, formatter: ->(severity, datetime, progname, msg) { "[LangChain.rb]".yellow + " #{msg}\n" })
 
   @root = Pathname.new(__dir__)
 
   autoload :Loader, "langchain/loader"
   autoload :Data, "langchain/data"
+  autoload :DependencyHelper, "langchain/dependency_helper"
 
   module Agent
     autoload :Base, "langchain/agent/base"
@@ -28,6 +29,7 @@ module Langchain
   module Tool
     autoload :Base, "langchain/tool/base"
     autoload :Calculator, "langchain/tool/calculator"
+    autoload :RubyCodeInterpreter, "langchain/tool/ruby_code_interpreter"
     autoload :SerpApi, "langchain/tool/serp_api"
     autoload :Wikipedia, "langchain/tool/wikipedia"
   end
@@ -58,6 +60,7 @@ module Langchain
   end
 
   module LLM
+    autoload :AI21, "langchain/llm/ai21"
     autoload :Base, "langchain/llm/base"
     autoload :Cohere, "langchain/llm/cohere"
     autoload :GooglePalm, "langchain/llm/google_palm"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: langchainrb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tiktoken_ruby
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: dotenv-rails
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ai21
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: chroma-db
   requirement: !ruby/object:Gem::Requirement
@@ -276,6 +332,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: safe_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: weaviate-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -325,12 +395,13 @@ files:
 - examples/store_and_query_with_pinecone.rb
 - examples/store_and_query_with_qdrant.rb
 - examples/store_and_query_with_weaviate.rb
-- lib/dependency_helper.rb
 - lib/langchain.rb
 - lib/langchain/agent/base.rb
 - lib/langchain/agent/chain_of_thought_agent/chain_of_thought_agent.rb
 - lib/langchain/agent/chain_of_thought_agent/chain_of_thought_agent_prompt.json
 - lib/langchain/data.rb
+- lib/langchain/dependency_helper.rb
+- lib/langchain/llm/ai21.rb
 - lib/langchain/llm/base.rb
 - lib/langchain/llm/cohere.rb
 - lib/langchain/llm/google_palm.rb
@@ -353,6 +424,7 @@ files:
 - lib/langchain/prompt/prompt_template.rb
 - lib/langchain/tool/base.rb
 - lib/langchain/tool/calculator.rb
+- lib/langchain/tool/ruby_code_interpreter.rb
 - lib/langchain/tool/serp_api.rb
 - lib/langchain/tool/wikipedia.rb
 - lib/langchain/utils/token_length_validator.rb
@@ -363,8 +435,8 @@ files:
 - lib/langchain/vectorsearch/pinecone.rb
 - lib/langchain/vectorsearch/qdrant.rb
 - lib/langchain/vectorsearch/weaviate.rb
+- lib/langchain/version.rb
 - lib/langchainrb.rb
-- lib/version.rb
 - sig/langchain.rbs
 homepage: https://rubygems.org/gems/langchainrb
 licenses:

data/lib/dependency_helper.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-VersionError = Class.new(ScriptError)
-
-# This method requires and loads the given gem, and then checks to see if the version of the gem meets the requirements listed in `langchain.gemspec`
-# This solution was built to avoid auto-loading every single gem in the Gemfile when the developer will mostly likely be only using a few of them.
-#
-# @param gem_name [String] The name of the gem to load
-# @return [Boolean] Whether or not the gem was loaded successfully
-# @raise [LoadError] If the gem is not installed
-# @raise [VersionError] If the gem is installed, but the version does not meet the requirements
-#
-def depends_on(gem_name)
-  gem(gem_name) # require the gem
-
-  return(true) unless defined?(Bundler) # If we're in a non-bundler environment, we're no longer able to determine if we'll meet requirements
-
-  gem_version = Gem.loaded_specs[gem_name].version
-  gem_requirement = Bundler.load.dependencies.find { |g| g.name == gem_name }&.requirement
-
-  raise LoadError unless gem_requirement
-
-  unless gem_requirement.satisfied_by?(gem_version)
-    raise VersionError, "The #{gem_name} gem is installed, but version #{gem_requirement} is required. You have #{gem_version}."
-  end
-
-  true
-rescue LoadError
-  raise LoadError, "Could not load #{gem_name}. Please ensure that the #{gem_name} gem is installed."
-end