langchainrb 0.3.2 → 0.3.4

data/lib/tool/base.rb

@@ -12,27 +12,39 @@ module Tool
     TOOLS = {
       "calculator" => "Tool::Calculator",
       "search" => "Tool::SerpApi",
-      "wikipedia" => "Tool::Wikipedia"
+      "wikipedia" => "Tool::Wikipedia",
+      "news" => "Tool::News"
     }
 
-    # Executes the tool and returns the answer
+    def self.description(value)
+      const_set(:DESCRIPTION, value.tr("\n", " ").strip)
+    end
+
+    # Instantiates and executes the tool and returns the answer
     # @param input [String] input to the tool
     # @return [String] answer
     def self.execute(input:)
-      raise NotImplementedError, "Your tool must implement the `self.execute(input:)` method that returns a string"
+      new.execute(input: input)
+    end
+
+    # Executes the tool and returns the answer
+    # @param input [String] input to the tool
+    # @return [String] answer
+    def execute(input:)
+      raise NotImplementedError, "Your tool must implement the `#execute(input:)` method that returns a string"
     end
 
-    # 
+    #
     # Validates the list of strings (tools) are all supported or raises an error
     # @param tools [Array<String>] list of tools to be used
-    # 
+    #
     # @raise [ArgumentError] If any of the tools are not supported
-    # 
+    #
     def self.validate_tools!(tools:)
-      unrecognized_tools = tools - Tool::Base::TOOLS.keys 
+      unrecognized_tools = tools - Tool::Base::TOOLS.keys
 
       if unrecognized_tools.any?
-        raise ArgumentError, "Unrecognized Tools: #{unrecognized_tools}" 
+        raise ArgumentError, "Unrecognized Tools: #{unrecognized_tools}"
       end
     end
   end

data/lib/tool/calculator.rb

@@ -1,17 +1,23 @@
 # frozen_string_literal: true
 
-require "eqn"
-
 module Tool
   class Calculator < Base
-    DESCRIPTION = "Useful for getting the result of a math expression. " +
-      "The input to this tool should be a valid mathematical expression that could be executed by a simple calculator."
+    description <<~DESC
+      Useful for getting the result of a math expression.
+
+      The input to this tool should be a valid mathematical expression that could be executed by a simple calculator.
+    DESC
+
+    def initialize
+      depends_on "eqn"
+      require "eqn"
+    end
 
     # 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
-    def self.execute(input:)
+    def execute(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/tool/serp_api.rb

@@ -1,39 +1,51 @@
 # frozen_string_literal: true
 
-require "google_search_results"
-
 module Tool
   class SerpApi < Base
     # Wrapper around SerpAPI
     # Set ENV["SERPAPI_API_KEY"] to use it
 
-    DESCRIPTION = "A wrapper around Google Search. " +
-      "Useful for when you need to answer questions about current events. " +
-      "Always one of the first options when you need to find information on internet. " +
-      "Input should be a search query."
+    description <<~DESC
+      A wrapper around Google Search.
+
+      Useful for when you need to answer questions about current events.
+      Always one of the first options when you need to find information on internet.
+
+      Input should be a search query.
+    DESC
+
+    def initialize
+      depends_on "google_search_results"
+      require "google_search_results"
+    end
+
+    # Executes Google Search and returns hash_results JSON
+    # @param input [String] search query
+    # @return [Hash] hash_results JSON
+
+    def self.execute_search(input:)
+      new.execute_search(input: input)
+    end
 
     # Executes Google Search and returns hash_results JSON
     # @param input [String] search query
     # @return [String] Answer
     # 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 self.execute(input:)
-      hash_results = self.execute_search(input: input)
+    def execute(input:)
+      hash_results = execute_search(input: input)
 
       hash_results.dig(:answer_box, :answer) ||
         hash_results.dig(:answer_box, :snippet) ||
         hash_results.dig(:organic_results, 0, :snippet)
     end
 
-    # Executes Google Search and returns hash_results JSON
-    # @param input [String] search query
-    # @return [Hash] hash_results JSON
-    def self.execute_search(input:)
+    def execute_search(input:)
       GoogleSearch.new(
         q: input,
         serp_api_key: ENV["SERPAPI_API_KEY"]
       )
-      .get_hash
+        .get_hash
     end
   end
 end

data/lib/tool/wikipedia.rb

@@ -1,23 +1,30 @@
 # frozen_string_literal: true
 
-require 'wikipedia'
-
 module Tool
   class Wikipedia < Base
     # Tool that adds the capability to search using the Wikipedia API
 
-    DESCRIPTION = "A wrapper around Wikipedia. " +
-      "Useful for when you need to answer general questions about " +
-      "people, places, companies, facts, historical events, or other subjects. " +
-      "Input should be a search query."
+    description <<~DESC
+      A wrapper around Wikipedia.
+
+      Useful for when you need to answer general questions about
+      people, places, companies, facts, historical events, or other subjects.
+
+      Input should be a search query.
+    DESC
+
+    def initialize
+      depends_on "wikipedia-client"
+      require "wikipedia"
+    end
 
     # Executes Wikipedia API search and returns the answer
     # @param input [String] search query
     # @return [String] Answer
-    def self.execute(input:)
+    def execute(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 
+      page.summary
     end
   end
 end

data/lib/vectorsearch/base.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Vectorsearch
   class Base
     extend Forwardable
 
     attr_reader :client, :index_name, :llm, :llm_api_key, :llm_client
 
-    DEFAULT_METRIC = "cosine".freeze
+    DEFAULT_METRIC = "cosine"
 
     # @param llm [Symbol] The LLM to use
     # @param llm_api_key [String] The API key for the LLM
@@ -46,7 +48,7 @@ module Vectorsearch
           input_variables: ["context"]
         ),
         examples: [
-          { context: context }
+          {context: context}
         ],
         input_variables: ["question"],
         example_separator: "\n"
@@ -55,4 +57,4 @@ module Vectorsearch
       prompt_template.format(question: question)
     end
   end
-end
+end

data/lib/vectorsearch/milvus.rb

@@ -1,27 +1,18 @@
 # frozen_string_literal: true
 
-require "milvus"
-
 module Vectorsearch
   class Milvus < Base
-    def initialize(
-      url:,
-      api_key: nil,
-      index_name:,
-      llm:,
-      llm_api_key:
-    )
-      @client = ::Milvus::Client.new(
-        url: url
-      )
+    def initialize(url:, index_name:, llm:, llm_api_key:, api_key: nil)
+      depends_on "milvus"
+      require "milvus"
+
+      @client = ::Milvus::Client.new(url: url)
       @index_name = index_name
 
       super(llm: llm, llm_api_key: llm_api_key)
     end
 
-    def add_texts(
-      texts:
-    )
+    def add_texts(texts:)
       client.entities.insert(
         collection_name: index_name,
         num_rows: texts.count,
@@ -77,10 +68,7 @@ module Vectorsearch
       )
     end
 
-    def similarity_search(
-      query:,
-      k: 4
-    )
+    def similarity_search(query:, k: 4)
       embedding = generate_embedding(text: query)
 
       similarity_search_by_vector(
@@ -89,14 +77,11 @@ module Vectorsearch
       )
     end
 
-    def similarity_search_by_vector(
-      embedding:,
-      k: 4
-    )
+    def similarity_search_by_vector(embedding:, k: 4)
       client.search(
         collection_name: index_name,
         top_k: k.to_s,
-        vectors: [ embedding ],
+        vectors: [embedding],
         dsl_type: 1,
         params: "{\"nprobe\": 10}",
         anns_field: "content",

data/lib/vectorsearch/pinecone.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "pinecone"
-
 module Vectorsearch
   class Pinecone < Base
     # Initialize the Pinecone client
@@ -10,18 +8,15 @@ module Vectorsearch
     # @param index_name [String] The name of the index to use
     # @param llm [Symbol] The LLM to use
     # @param llm_api_key [String] The API key for the LLM
-    def initialize(
-      environment:,
-      api_key:,
-      index_name:,
-      llm:,
-      llm_api_key:
-    )
+    def initialize(environment:, api_key:, index_name:, llm:, llm_api_key:)
+      depends_on "pinecone"
+      require "pinecone"
+
       ::Pinecone.configure do |config|
-        config.api_key  = api_key
+        config.api_key = api_key
         config.environment = environment
       end
-    
+
       @client = ::Pinecone::Client.new
       @index_name = index_name
 
@@ -31,14 +26,12 @@ module Vectorsearch
     # Add a list of texts to the index
     # @param texts [Array] The list of texts to add
     # @return [Hash] The response from the server
-    def add_texts(
-      texts:
-    )
+    def add_texts(texts:)
       vectors = texts.map do |text|
         {
           # TODO: Allows passing in your own IDs
           id: SecureRandom.uuid,
-          metadata: { content: text },
+          metadata: {content: text},
           values: generate_embedding(text: text)
         }
       end
@@ -78,10 +71,7 @@ module Vectorsearch
     # @param embedding [Array] The embedding to search for
     # @param k [Integer] The number of results to return
     # @return [Array] The list of results
-    def similarity_search_by_vector(
-      embedding:,
-      k: 4
-    )
+    def similarity_search_by_vector(embedding:, k: 4)
       index = client.index(index_name)
 
       response = index.query(
@@ -109,4 +99,4 @@ module Vectorsearch
       generate_completion(prompt: prompt)
     end
   end
-end
+end

data/lib/vectorsearch/qdrant.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "qdrant"
-
 module Vectorsearch
   class Qdrant < Base
     # Initialize the Qdrant client
@@ -10,13 +8,10 @@ module Vectorsearch
     # @param index_name [String] The name of the index to use
     # @param llm [Symbol] The LLM to use
     # @param llm_api_key [String] The API key for the LLM
-    def initialize(
-      url:,
-      api_key:,
-      index_name:,
-      llm:,
-      llm_api_key:
-    )
+    def initialize(url:, api_key:, index_name:, llm:, llm_api_key:)
+      depends_on "qdrant-ruby"
+      require "qdrant"
+
       @client = ::Qdrant::Client.new(
         url: url,
         api_key: api_key
@@ -29,15 +24,13 @@ module Vectorsearch
     # Add a list of texts to the index
     # @param texts [Array] The list of texts to add
     # @return [Hash] The response from the server
-    def add_texts(
-      texts:
-    )
-      batch = { ids: [], vectors: [], payloads: [] }
+    def add_texts(texts:)
+      batch = {ids: [], vectors: [], payloads: []}
 
       texts.each do |text|
         batch[:ids].push(SecureRandom.uuid)
         batch[:vectors].push(generate_embedding(text: text))
-        batch[:payloads].push({ content: text })
+        batch[:payloads].push({content: text})
       end
 
       client.points.upsert(
@@ -106,4 +99,4 @@ module Vectorsearch
       generate_completion(prompt: prompt)
     end
   end
-end
+end

data/lib/vectorsearch/weaviate.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "weaviate"
-
 module Vectorsearch
   class Weaviate < Base
     # Initialize the Weaviate adapter
@@ -10,13 +8,10 @@ module Vectorsearch
     # @param index_name [String] The name of the index to use
     # @param llm [Symbol] The LLM to use
     # @param llm_api_key [String] The API key for the LLM
-    def initialize(
-      url:,
-      api_key:,
-      index_name:,
-      llm:,
-      llm_api_key:
-    )
+    def initialize(url:, api_key:, index_name:, llm:, llm_api_key:)
+      depends_on "weaviate-ruby"
+      require "weaviate"
+
       @client = ::Weaviate::Client.new(
         url: url,
         api_key: api_key,
@@ -31,13 +26,11 @@ module Vectorsearch
     # Add a list of texts to the index
     # @param texts [Array] The list of texts to add
     # @return [Hash] The response from the server
-    def add_texts(
-      texts:
-    )
+    def add_texts(texts:)
       objects = texts.map do |text|
         {
           class: index_name,
-          properties: { content: text }
+          properties: {content: text}
         }
       end
 
@@ -50,7 +43,7 @@ module Vectorsearch
     def create_default_schema
       client.schema.create(
         class_name: index_name,
-        vectorizer: "text2vec-#{llm.to_s}",
+        vectorizer: "text2vec-#{llm}",
         # TODO: Figure out a way to optionally enable it
         # "module_config": {
         #   "qna-openai": {}
@@ -69,10 +62,7 @@ module Vectorsearch
     # @param query [String] The query to search for
     # @param k [Integer|String] The number of results to return
     # @return [Hash] The search results
-    def similarity_search(
-      query:,
-      k: 4
-    )
+    def similarity_search(query:, k: 4)
       near_text = "{ concepts: [\"#{query}\"] }"
 
       client.query.get(
@@ -87,10 +77,7 @@ module Vectorsearch
     # @param embedding [Array] The vector to search for
     # @param k [Integer|String] The number of results to return
     # @return [Hash] The search results
-    def similarity_search_by_vector(
-      embedding:,
-      k: 4
-    )
+    def similarity_search_by_vector(embedding:, k: 4)
       near_vector = "{ vector: #{embedding} }"
 
       client.query.get(
@@ -104,9 +91,7 @@ module Vectorsearch
     # Ask a question and return the answer
     # @param question [String] The question to ask
     # @return [Hash] The answer
-    def ask(
-      question:
-    )
+    def ask(question:)
       # Weaviate currently supports the `ask:` parameter only for the OpenAI LLM (with `qna-openai` module enabled).
       # The Cohere support is on the way: https://github.com/weaviate/weaviate/pull/2600
       if llm == :openai
@@ -132,4 +117,4 @@ module Vectorsearch
       end
     end
   end
-end
+end

data/lib/version.rb

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