langchainrb 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cdb0b5fcbe9d764f04794320bf23e8cbea4dcd5ba7c504981c10a83cb73f09a
-  data.tar.gz: da4a97f7ae0fbc3739ee4a37f879a438773768fc1217e236508dbf370a319ade
+  metadata.gz: 1d43d7b8fab03608be188730dd7e67947e161176ea11ad29a3d6a3b3469045da
+  data.tar.gz: 2a0cf937f20dcb620fde4fac5bfdd1cbafee92d1212ab61fc25db352c3bce79f
 SHA512:
-  metadata.gz: 2be391ab8a2f2a235c4c853b1aec09a1c90fc4f537a6c98860cbbd924b07264b9173d1f28c0372440fd4c6a910c12c7d4fc1068c5ed02e744c18bedac37ed552
-  data.tar.gz: d856e73f6e4fd1df1107c3cbffd9bcaf141bfe1c1a028321ab66c8495b120d90be08d6ab982c442eda3ce4481a955b360601b1daf4754db43b0916c0214af0a2
+  metadata.gz: 2eb42e6ea5ee796bd7b78addd9c3cc75449ca84a680c0b50668eb678e14cb4991fe38577a323acbd628b30b3753a2197da8a34ef908dac15402277e078a8c287
+  data.tar.gz: 1a1d51903ef37908b2f0f5a2ded0542a04f5e812ff4c2fa37b67dbaa80636d50a70d7cf8bf05bfceedbe21a016d6dcb6e98a9fa3e25981feb05f4a4cec2ca52f

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## [Unreleased]
+## [0.3.0] - 2023-05-12
 
-## [0.1.0] - 2023-04-26
+- Agents
+  - Introducing `Agent::ChainOfThoughtAgent`, a semi-autonomous bot that uses Tools to retrieve additional information in order to make best-effort informed replies to user's questions.
+- Tools
+  - Introducing `Tool::Calculator` tool that solves mathematical expressions.
+  - Introducing `Tool::Search` tool that executes Google Searches.
+
+## [0.2.0] - 2023-05-09
+
+- Prompt Templating
+  - Ability to create prompt templates and save them to JSON files
+  - Default `Prompt::FewShotPromptTemplate`
+  - New examples added to `examples/`
+
+## [0.1.4] - 2023-05-02
+
+- Backfilling missing specs
+
+## [0.1.3] - 2023-05-01
 
 - Initial release

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    langchainrb (0.1.4)
-      cohere-ruby (~> 0.9.1)
+    langchainrb (0.3.0)
+      cohere-ruby (~> 0.9.3)
+      eqn (~> 1.6.5)
+      google_search_results (~> 2.0.0)
       milvus (~> 0.9.0)
       pinecone (~> 0.1.6)
       qdrant-ruby (~> 0.9.0)
@@ -33,8 +35,9 @@ GEM
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
-    cohere-ruby (0.9.1)
-      faraday (~> 2.7.0)
+    cohere-ruby (0.9.3)
+      faraday (~> 1)
+      faraday_middleware (~> 1)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
     diff-lcs (1.5.0)
@@ -79,15 +82,38 @@ GEM
       dry-initializer (~> 3.0)
       dry-schema (>= 1.12, < 2)
       zeitwerk (~> 2.6)
+    eqn (1.6.5)
+      treetop (>= 1.2.0)
     erubi (1.12.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (3.0.2)
-    graphlient (0.7.0)
-      faraday (~> 2.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    google_search_results (2.0.1)
+    graphlient (0.6.0)
+      faraday (>= 1.0)
+      faraday_middleware
       graphql-client
     graphql (2.0.21)
     graphql-client (0.18.0)
@@ -99,12 +125,12 @@ GEM
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    loofah (2.20.0)
+    loofah (2.21.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    milvus (0.9.0)
-      faraday (~> 2.7.0)
+    milvus (0.9.1)
+      faraday (~> 1)
     mini_mime (1.1.2)
     minitest (5.18.0)
     multi_xml (0.6.0)
@@ -117,14 +143,16 @@ GEM
       dry-struct (~> 1.6.0)
       dry-validation (~> 1.10.0)
       httparty (~> 0.21.0)
+    polyglot (0.3.5)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    qdrant-ruby (0.9.0)
-      faraday (~> 2.7)
+    qdrant-ruby (0.9.2)
+      faraday (~> 1)
+      faraday_middleware (~> 1)
     racc (1.6.2)
     rack (2.2.7)
     rack-test (2.1.0)
@@ -160,11 +188,14 @@ GEM
       faraday-multipart (>= 1)
     ruby2_keywords (0.0.5)
     thor (1.2.1)
+    treetop (1.6.12)
+      polyglot (~> 0.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    weaviate-ruby (0.8.0)
-      faraday (~> 2.7)
-      graphlient (~> 0.7.0)
+    weaviate-ruby (0.8.1)
+      faraday (~> 1)
+      faraday_middleware (~> 1)
+      graphlient (~> 0.6.0)
     zeitwerk (2.6.8)
 
 PLATFORMS

data/README.md

@@ -26,7 +26,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 require "langchain"
 ```
 
-List of currently supported vector search databases and features:
+#### Supported vector search databases and features:
 
 | Database | Querying           | Storage | Schema Management | Backups | Rails Integration | ??? |
 | -------- |:------------------:| -------:| -----------------:| -------:| -----------------:| ---:|
@@ -35,7 +35,7 @@ List of currently supported vector search databases and features:
 | Milvus   | :white_check_mark: | WIP     | WIP               | WIP     |                   |     |
 | Pinecone | :white_check_mark: | WIP     | WIP               | WIP     |                   |     |
 
-### Using Vector Search Databases
+### Using Vector Search Databases 🔍
 
 Choose the LLM provider you'll be using (OpenAI or Cohere) and retrieve the API key.
 
@@ -90,7 +90,7 @@ client.ask(
 )
 ```
 
-### Using Standalone LLMs
+### Using Standalone LLMs 🗣️
 
 #### OpenAI
 ```ruby
@@ -114,12 +114,134 @@ cohere.embed(text: "foo bar")
 cohere.complete(prompt: "What is the meaning of life?")
 ```
 
+### Using Prompts 📋
+
+#### Prompt Templates
+
+Create a prompt with one input variable:
+
+```ruby
+prompt = Prompt::PromptTemplate.new(template: "Tell me a {adjective} joke.", input_variables: ["adjective"])
+prompt.format(adjective: "funny") # "Tell me a funny joke."
+```
+
+Create a prompt with multiple input variables:
+
+```ruby
+prompt = Prompt::PromptTemplate.new(template: "Tell me a {adjective} joke about {content}.", input_variables: ["adjective", "content"])
+prompt.format(adjective: "funny", content: "chickens") # "Tell me a funny joke about chickens."
+```
+
+Creating a PromptTemplate using just a prompt and no input_variables:
+
+```ruby
+prompt = Prompt::PromptTemplate.from_template("Tell me a {adjective} joke about {content}.")
+prompt.input_variables # ["adjective", "content"]
+prompt.format(adjective: "funny", content: "chickens") # "Tell me a funny joke about chickens."
+```
+
+Save prompt template to JSON file:
+
+```ruby
+prompt.save(file_path: "spec/fixtures/prompt/prompt_template.json")
+```
+
+Loading a new prompt template using a JSON file:
+
+```ruby
+prompt = Prompt.load_from_path(file_path: "spec/fixtures/prompt/prompt_template.json")
+prompt.input_variables # ["adjective", "content"]
+```
+
+#### Few Shot Prompt Templates
+
+Create a prompt with a few shot examples:
+
+```ruby
+prompt = Prompt::FewShotPromptTemplate.new(
+  prefix: "Write antonyms for the following words.",
+  suffix: "Input: {adjective}\nOutput:",
+  example_prompt: Prompt::PromptTemplate.new(
+    input_variables: ["input", "output"],
+    template: "Input: {input}\nOutput: {output}"
+  ),
+  examples: [
+    { "input": "happy", "output": "sad" },
+    { "input": "tall", "output": "short" }
+  ],
+   input_variables: ["adjective"]
+)
+
+prompt.format(adjective: "good")
+
+# Write antonyms for the following words.
+#
+# Input: happy
+# Output: sad
+#
+# Input: tall
+# Output: short
+#
+# Input: good
+# Output:
+```
+
+Save prompt template to JSON file:
+
+```ruby
+prompt.save(file_path: "spec/fixtures/prompt/few_shot_prompt_template.json")
+```
+
+Loading a new prompt template using a JSON file:
+
+```ruby
+prompt = Prompt.load_from_path(file_path: "spec/fixtures/prompt/few_shot_prompt_template.json")
+prompt.prefix # "Write antonyms for the following words."
+```
+
+### Using Agents 🤖
+Agents are semi-autonomous bots that can respond to user questions and use available to them Tools to provide informed replies. They break down problems into series of steps and define Actions (and Action Inputs) along the way that are executed and fed back to them as additional information. Once an Agent decides that it has the Final Answer it responds with it.
+
+#### Chain-of-Thought Agent
+
+```ruby
+agent = Agent::ChainOfThoughtAgent.new(llm: :openai, llm_api_key: ENV["OPENAI_API_KEY"], tools: ['search', 'calculator'])
+
+agent.tools
+# => ["search", "calculator"]
+```
+```ruby
+agent.run(question: "How many full soccer fields would be needed to cover the distance between NYC and DC in a straight line?", logging: true)
+#=> "Approximately 2,945 soccer fields would be needed to cover the distance between NYC and DC in a straight line."
+```
+
+#### Demo
+![May-12-2023 13-09-13](https://github.com/andreibondarev/langchainrb/assets/541665/6bad4cd9-976c-420f-9cf9-b85bf84f7eaf)
+
+![May-12-2023 13-07-45](https://github.com/andreibondarev/langchainrb/assets/541665/9aacdcc7-4225-4ea0-ab96-7ee48826eb9b)
+
+#### Available Tools 🛠️
+
+| Name     | Description          | Requirements         |
+| -------- | :------------------: | :------------------: |
+| "search" | A wrapper around Google Search | `ENV["SERP_API_KEY"]` (https://serpapi.com/manage-api-key)
+| "calculator" | Useful for getting the result of a math expression | |
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## 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)
+
+## Honorary 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)
+[<img style="border-radius:50%" alt="Rafael Figueiredo" src="https://avatars.githubusercontent.com/u/35845775?v=4" width="80" height="80" class="avatar">](https://github.com/rafaelqfigueiredo)
+
+(Criteria of becoming an Honorary Contributor or Core Contributor is pending...)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/andreibondarev/langchain.

data/examples/create_and_manage_few_shot_prompt_templates.rb

@@ -0,0 +1,36 @@
+require "langchain"
+
+# Create a prompt with a few shot examples
+prompt = Prompt::FewShotPromptTemplate.new(
+  prefix: "Write antonyms for the following words.",
+  suffix: "Input: {adjective}\nOutput:",
+  example_prompt: Prompt::PromptTemplate.new(
+    input_variables: ["input", "output"],
+    template: "Input: {input}\nOutput: {output}"
+  ),
+  examples: [
+    { "input": "happy", "output": "sad" },
+    { "input": "tall", "output": "short" }
+  ],
+   input_variables: ["adjective"]
+)
+
+prompt.format(adjective: "good")
+
+# Write antonyms for the following words.
+#
+# Input: happy
+# Output: sad
+#
+# Input: tall
+# Output: short
+#
+# Input: good
+# Output:
+
+# Save prompt template to JSON file
+prompt.save(file_path: "spec/fixtures/prompt/few_shot_prompt_template.json")
+
+# Loading a new prompt template using a JSON file
+prompt = Prompt.load_from_path(file_path: "spec/fixtures/prompt/few_shot_prompt_template.json")
+prompt.prefix # "Write antonyms for the following words."

data/examples/create_and_manage_prompt_templates.rb

@@ -0,0 +1,21 @@
+require "langchain"
+
+# Create a prompt with one input variable
+prompt = Prompt::PromptTemplate.new(template: "Tell me a {adjective} joke.", input_variables: ["adjective"])
+prompt.format(adjective: "funny") # "Tell me a funny joke."
+
+# Create a prompt with multiple input variables
+prompt = Prompt::PromptTemplate.new(template: "Tell me a {adjective} joke about {content}.", input_variables: ["adjective", "content"])
+prompt.format(adjective: "funny", content: "chickens") # "Tell me a funny joke about chickens."
+
+# Creating a PromptTemplate using just a prompt and no input_variables
+prompt = Prompt::PromptTemplate.from_template("Tell me a {adjective} joke about {content}.")
+prompt.input_variables # ["adjective", "content"]
+prompt.format(adjective: "funny", content: "chickens") # "Tell me a funny joke about chickens."
+
+# Save prompt template to JSON file
+prompt.save(file_path: "spec/fixtures/prompt/prompt_template.json")
+
+# Loading a new prompt template using a JSON file
+prompt = Prompt.load_from_path(file_path: "spec/fixtures/prompt/prompt_template.json")
+prompt.input_variables # ["adjective", "content"]

data/lib/agent/base.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Agent
+  class Base
+  end
+end

data/lib/agent/chain_of_thought_agent/chain_of_thought_agent.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Agent
+  class ChainOfThoughtAgent < Base
+    attr_reader :llm, :llm_api_key, :llm_client, :tools
+
+    # Initializes the Agent
+    # 
+    # @param llm [Symbol] The LLM to use
+    # @param llm_api_key [String] The API key for the LLM
+    # @param tools [Array] The tools to use
+    # @return [ChainOfThoughtAgent] The Agent::ChainOfThoughtAgent instance
+    def initialize(llm:, llm_api_key:, tools: [])
+      LLM::Base.validate_llm!(llm: llm)
+      Tool::Base.validate_tools!(tools: tools)
+
+      @llm = llm
+      @llm_api_key = llm_api_key
+      @tools = tools
+
+      @llm_client = LLM.const_get(LLM::Base::LLMS.fetch(llm)).new(api_key: llm_api_key)
+    end
+
+    # Validate tools when they're re-assigned
+    # 
+    # @param value [Array] The tools to use
+    # @return [Array] The tools that will be used
+    def tools=(value)
+      Tool::Base.validate_tools!(tools: value)
+      @tools = value
+    end
+
+    # Run the Agent!
+    # 
+    # @param question [String] The question to ask
+    # @param logging [Boolean] Whether or not to log the Agent's actions
+    # @return [String] The answer to the question
+    def run(question:, logging: false)
+      question = question.strip
+      prompt = create_prompt(
+        question: question,
+        tools: tools
+      )
+
+      loop do
+        puts("Agent: Passing the prompt to the #{llm} LLM") if logging
+        response = llm_client.generate_completion(
+          prompt: prompt,
+          stop_sequences: ["Observation:"],
+          max_tokens: 500
+        )
+
+        # Append the response to the prompt
+        prompt += response;
+    
+        # Find the requested action in the "Action: search" format
+        action = response.match(/Action: (.*)/)&.send(:[], -1)
+        
+        if action
+          # Find the input to the action in the "Action Input: [action_input]" format
+          action_input = response.match(/Action Input: "?(.*)"?/)&.send(:[], -1)
+
+          puts("Agent: Using the \"#{action}\" Tool with \"#{action_input}\"") if logging
+
+          # Retrieve the Tool::[ToolName] class and call `execute`` with action_input as the input
+          result = Tool
+            .const_get(Tool::Base::TOOLS[action.strip])
+            .execute(input: action_input)
+
+          # Append the Observation to the prompt
+          if prompt.end_with?("Observation:")
+            prompt += " #{result}\nThought:"
+          else
+            prompt += "\nObservation: #{result}\nThought:"
+          end
+        else
+          # Return the final answer
+          break response.match(/Final Answer: (.*)/)&.send(:[], -1)
+        end
+      end
+    end
+
+    private
+
+    # Create the initial prompt to pass to the LLM
+    # @param question [String] Question to ask
+    # @param tools [Array] Tools to use
+    # @return [String] Prompt
+    def create_prompt(question:, tools:)
+      prompt_template.format(
+        date: Date.today.strftime("%B %d, %Y"),
+        question: question,
+        tool_names: "[#{tools.join(", ")}]",
+        tools: tools.map do |tool|
+          "#{tool}: #{Tool.const_get(Tool::Base::TOOLS[tool]).const_get("DESCRIPTION")}"
+        end.join("\n")
+      )
+    end
+
+    # Load the PromptTemplate from the JSON file
+    # @return [PromptTemplate] PromptTemplate instance
+    def prompt_template
+      @template ||= Prompt.load_from_path(
+        file_path: "lib/agent/chain_of_thought_agent/chain_of_thought_agent_prompt.json"
+      )
+    end
+  end
+end

data/lib/agent/chain_of_thought_agent/chain_of_thought_agent_prompt.json

@@ -0,0 +1,10 @@
+{
+  "_type": "prompt",
+  "template": "Today is {date} and you can use tools to get new information. Answer the following questions as best you can using the following tools:\n\n{tools}\n\nUse the following format:\n\nQuestion: the input question you must answer\nThought: you should always think about what to do\nAction: the action to take, should be one of {tool_names}\nAction Input: the input to the action\nObservation: the result of the action\n... (this Thought/Action/Action Input/Observation can repeat N times)\nThought: I now know the final answer\nFinal Answer: the final answer to the original input question\n\nBegin!\n\nQuestion: {question}\nThought:",
+  "input_variables": [
+    "date",
+    "question",
+    "tools",
+    "tool_names"
+  ]
+}

data/lib/langchain.rb

@@ -2,6 +2,11 @@
 
 require_relative "./version"
 
+module Agent
+  autoload :Base, "agent/base"
+  autoload :ChainOfThoughtAgent, "agent/chain_of_thought_agent/chain_of_thought_agent.rb"
+end
+
 module Vectorsearch
   autoload :Base, "vectorsearch/base"
   autoload :Milvus, "vectorsearch/milvus"
@@ -14,4 +19,18 @@ module LLM
   autoload :Base, "llm/base"
   autoload :Cohere, "llm/cohere"
   autoload :OpenAI, "llm/openai"
-end
+end
+
+module Prompt
+  require_relative "prompt/loading"
+
+  autoload :Base, "prompt/base"
+  autoload :PromptTemplate, "prompt/prompt_template"
+  autoload :FewShotPromptTemplate, "prompt/few_shot_prompt_template"
+end
+
+module Tool
+  autoload :Base, "tool/base"
+  autoload :Calculator, "tool/calculator"
+  autoload :SerpApi, "tool/serp_api"
+end

data/lib/llm/base.rb

@@ -14,5 +14,14 @@ module LLM
     def default_dimension
       self.class.const_get("DEFAULTS").dig(:dimension)
     end
+
+    # Ensure that the LLM value passed in is supported
+    # @param llm [Symbol] The LLM to use
+    def self.validate_llm!(llm:)
+      # TODO: Fix so this works when `llm` value is a string instead of a symbol
+      unless LLM::Base::LLMS.keys.include?(llm)
+        raise ArgumentError, "LLM must be one of #{LLM::Base::LLMS.keys}"
+      end
+    end
   end
 end

data/lib/llm/cohere.rb

@@ -30,12 +30,20 @@ module LLM
     # Generate a completion for a given prompt
     # @param prompt [String] The prompt to generate a completion for
     # @return [Hash] The completion
-    def complete(prompt:)
-      response = client.generate(
+    def complete(prompt:, **params)
+      default_params = {
         prompt: prompt,
         temperature: DEFAULTS[:temperature],
-        model: DEFAULTS[:completion_model_name],
-      )
+        model: DEFAULTS[:completion_model_name]
+      }
+
+      if params[:stop_sequences]
+        default_params[:stop_sequences] = params.delete(:stop_sequences)
+      end
+
+      default_params.merge!(params)
+
+      response = client.generate(**default_params)
       response.dig("generations").first.dig("text")
     end
 

data/lib/llm/openai.rb

@@ -33,15 +33,21 @@ module LLM
     # Generate a completion for a given prompt
     # @param prompt [String] The prompt to generate a completion for
     # @return [String] The completion
-    def complete(prompt:)
-      response = client.completions(
-        parameters: {
-          model: DEFAULTS[:completion_model_name],
-          temperature: DEFAULTS[:temperature],
-          prompt: prompt
-        }
-      )
-      response.dig("choices").first.dig("text")
+    def complete(prompt:, **params)
+      default_params = {
+        model: DEFAULTS[:completion_model_name],
+        temperature: DEFAULTS[:temperature],
+        prompt: prompt
+      }
+
+      if params[:stop_sequences]
+        default_params[:stop] = params.delete(:stop_sequences)
+      end
+
+      default_params.merge!(params)
+
+      response = client.completions(parameters: default_params)
+      response.dig("choices", 0, "text")
     end
 
     alias_method :generate_completion, :complete

data/lib/prompt/base.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'strscan'
+
+module Prompt
+  class Base
+    def format(**kwargs)
+      raise NotImplementedError
+    end
+
+    def prompt_type
+      raise NotImplementedError
+    end
+
+    def to_h
+      raise NotImplementedError
+    end
+
+    #
+    # Validate the input variables against the template.
+    #
+    # @param template [String] The template to validate against.
+    # @param input_variables [Array<String>] The input variables to validate.
+    #
+    # @raise [ArgumentError] If there are missing or extra variables.
+    #
+    # @return [void]
+    #
+    def validate(template:, input_variables:)
+      input_variables_set = @input_variables.uniq
+      variables_from_template = Prompt::Base.extract_variables_from_template(template)
+
+      missing_variables = variables_from_template - input_variables_set
+      extra_variables = input_variables_set - variables_from_template
+
+      raise ArgumentError, "Missing variables: #{missing_variables}" if missing_variables.any?
+      raise ArgumentError, "Extra variables: #{extra_variables}" if extra_variables.any?
+    end
+
+    #
+    # Save the object to a file in JSON format.
+    #
+    # @param file_path [String, Pathname] The path to the file to save the object to
+    #
+    # @raise [ArgumentError] If file_path doesn't end with .json
+    #
+    # @return [void]
+    #
+    def save(file_path:)
+      save_path = file_path.is_a?(String) ? Pathname.new(file_path) : file_path
+      directory_path = save_path.dirname
+      FileUtils.mkdir_p(directory_path) unless directory_path.directory?
+
+      if save_path.extname == ".json"
+        File.open(file_path, "w") { |f| f.write(to_h.to_json) }
+      else
+        raise ArgumentError, "#{file_path} must be json"
+      end
+    end
+
+    private
+
+    #
+    # Extracts variables from a template string.
+    #
+    # 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}").
+    #
+    # @param template [String] The template string to extract variables from.
+    #
+    # @return [Array<String>] An array of input variable names.
+    #
+    def self.extract_variables_from_template(template)
+      input_variables = []
+      scanner = StringScanner.new(template)
+
+      while scanner.scan_until(/\{([^{}]*)\}/)
+        variable = scanner[1].strip
+        input_variables << variable unless variable.empty?
+      end
+
+      input_variables
+    end
+  end
+end

data/lib/prompt/few_shot_prompt_template.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Prompt
+  class FewShotPromptTemplate < Base
+    attr_reader :examples, :example_prompt, :input_variables, :prefix, :suffix, :example_separator
+
+    #
+    # Initializes a new instance of the class.
+    #
+    # @param examples [Array<Hash>] Examples to format into the prompt.
+    # @param example_prompt [PromptTemplate] PromptTemplate used to format an individual example.
+    # @param suffix [String] A prompt template string to put after the examples.
+    # @param input_variables [Array<String>] A list of the names of the variables the prompt template expects.
+    # @param example_separator [String] String separator used to join the prefix, the examples, and suffix.
+    # @param prefix [String] A prompt template string to put before the examples.
+    # @param validate_template [Boolean] Whether or not to try validating the template.
+    #
+    def initialize(
+      examples:,
+      example_prompt:,
+      input_variables:,
+      suffix:,
+      prefix: "",
+      example_separator: "\n\n",
+      validate_template: true
+    )
+      @examples = examples
+      @example_prompt = example_prompt
+      @input_variables = input_variables
+      @prefix = prefix
+      @suffix = suffix
+      @example_separator = example_separator
+
+      validate(template: @prefix + @suffix, input_variables: @input_variables) if @validate_template
+    end
+
+    #
+    # Format the prompt with the inputs.
+    #
+    # @param kwargs [Hash] Any arguments to be passed to the prompt template.
+    #
+    # @return [String] A formatted string.
+    #
+    def format(**kwargs)
+      example_string = @examples.map { |example| @example_prompt.format(**example) }
+
+      suffix_string = @suffix
+      kwargs.each { |key, value| suffix_string = suffix_string.gsub(/\{#{key}\}/, value.to_s) }
+
+      [@prefix, *example_string, suffix_string].join(@example_separator)
+    end
+
+    #
+    # Returns the key type of prompt as a string.
+    #
+    # @return [String] the prompt type key
+    #
+    def prompt_type
+      "few_shot"
+    end
+
+    def to_h
+      {
+        _type: prompt_type,
+        input_variables: @input_variables,
+        prefix: @prefix,
+        example_prompt: @example_prompt.to_h,
+        examples: @examples,
+        suffix: @suffix
+      }
+    end
+  end
+end

data/lib/prompt/loading.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'strscan'
+require 'pathname'
+
+module Prompt
+  TYPE_TO_LOADER = {
+    "prompt" => ->(config) { Prompt.load_prompt(config) },
+    "few_shot" => ->(config) { Prompt.load_few_shot_prompt(config) }
+  }
+
+  class << self
+    #
+    # Load prompt from file.
+    #
+    # @param file_path [String, Pathname] The path of the file to read the configuration data from.
+    #
+    # @return [Object] The loaded prompt loaded.
+    #
+    # @raise [ArgumentError] If the file type of the specified file path is not supported.
+    #
+    def load_from_path(file_path:)
+      file_path = file_path.is_a?(String) ? Pathname.new(file_path) : file_path
+
+      if file_path.extname == ".json"
+        config = JSON.parse(File.read(file_path))
+      else
+        raise ArgumentError, "Got unsupported file type #{file_path.extname}"
+      end
+
+      load_from_config(config)
+    end
+
+    #
+    # Loads a prompt template with the given configuration.
+    #
+    # @param config [Hash] A hash containing the configuration for the prompt.
+    #
+    # @return [PromptTemplate] The loaded prompt loaded.
+    #
+    def load_prompt(config)
+      template, input_variables = config.values_at("template", "input_variables")
+      PromptTemplate.new(template: template, input_variables: input_variables)
+    end
+
+    #
+    # Loads a prompt template with the given configuration.
+    #
+    # @param config [Hash] A hash containing the configuration for the prompt.
+    #
+    # @return [FewShotPromptTemplate] The loaded prompt loaded.
+    #
+    def load_few_shot_prompt(config)
+      prefix, suffix, example_prompt, examples, input_variables = config.values_at("prefix", "suffix", "example_prompt", "examples", "input_variables")
+      example_prompt = load_prompt(example_prompt)
+      FewShotPromptTemplate.new(prefix: prefix, suffix: suffix, example_prompt: example_prompt, examples: examples, input_variables: input_variables)
+    end
+
+    private
+
+    #
+    # Loads the prompt from the given configuration hash
+    #
+    # @param config [Hash] the configuration hash to load from
+    #
+    # @return [Object] the loaded prompt
+    #
+    # @raise [ArgumentError] if the prompt type specified in the config is not supported
+    #
+    def load_from_config(config)
+      # If `_type` key is not present in the configuration hash, add it with a default value of `prompt`
+      unless config.key?("_type")
+        puts "[WARN] No `_type` key found, defaulting to `prompt`"
+        config["_type"] = "prompt"
+      end
+
+      # If the prompt type specified in the configuration hash is not supported, raise an exception
+      unless TYPE_TO_LOADER.key?(config["_type"])
+        raise ArgumentError, "Loading #{config["_type"]} prompt not supported"
+      end
+
+      # Load the prompt using the corresponding loader function from the `TYPE_TO_LOADER` hash
+      prompt_loader = TYPE_TO_LOADER[config["_type"]]
+      prompt_loader.call(config)
+    end
+  end
+end

data/lib/prompt/prompt_template.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Prompt
+  class PromptTemplate < Base
+    attr_reader :template, :input_variables, :validate_template
+
+    #
+    # Initializes a new instance of the class.
+    #
+    # @param template [String] The prompt template.
+    # @param input_variables [Array<String>] A list of the names of the variables the prompt template expects.
+    # @param validate_template [Boolean] Whether or not to try validating the template.
+    #
+    def initialize(template:, input_variables:, validate_template: true)
+      @template = template
+      @input_variables = input_variables
+      @validate_template = validate_template
+
+      validate(template: @template, input_variables: @input_variables) if @validate_template
+    end
+
+    #
+    # Format the prompt with the inputs.
+    #
+    # @param kwargs [Hash] Any arguments to be passed to the prompt template.
+    # @return [String] A formatted string.
+    #
+    def format(**kwargs)
+      result = @template
+      kwargs.each { |key, value| result = result.gsub(/\{#{key}\}/, value.to_s) }
+      result
+    end
+
+    #
+    # Returns the key type of prompt as a string.
+    #
+    # @return [String] the prompt type key
+    #
+    def prompt_type
+      "prompt"
+    end
+
+    def to_h
+      {
+        _type: prompt_type,
+        input_variables: @input_variables,
+        template: @template
+      }
+    end
+
+    #
+    # Creates a new instance of the class using the given template.
+    #
+    # @param template [String] The template to use
+    #
+    # @return [Object] A new instance of the class
+    #
+    def self.from_template(template)
+      new(template: template, input_variables: extract_variables_from_template(template))
+    end
+  end
+end

data/lib/tool/base.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Tool
+  class Base
+    # 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
+    #   "your_tool_name" => "Tool::YourToolName"
+    # 3. Implement `self.execute(input:)` method in your tool class
+    # 4. Add your tool to the README.md
+
+    TOOLS = {
+      "calculator" => "Tool::Calculator",
+      "search" => "Tool::SerpApi"
+    }
+
+    # 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"
+    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 
+
+      if unrecognized_tools.any?
+        raise ArgumentError, "Unrecognized Tools: #{unrecognized_tools}" 
+      end
+    end
+  end
+end

data/lib/tool/calculator.rb

@@ -0,0 +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."
+
+    # 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:)
+      Eqn::Calculator.calc(input)
+    rescue Eqn::ParseError, Eqn::NoVariableValueError
+      # Sometimes the input is not a pure math expression, e.g: "12F in Celsius"
+      # We can use the google answer box to evaluate this expression
+      hash_results = Tool::SerpApi.execute_search(input: input)
+      hash_results.dig(:answer_box, :to)
+    end
+  end
+end

data/lib/tool/serp_api.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "google_search_results"
+
+module Tool
+  class SerpApi < Base
+    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."
+
+    # 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)
+
+      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:)
+      GoogleSearch.new(
+        q: input,
+        serp_api_key: ENV["SERP_API_KEY"]
+      )
+      .get_hash
+    end
+  end
+end

data/lib/vectorsearch/base.rb

@@ -11,7 +11,7 @@ module Vectorsearch
     # @param llm [Symbol] The LLM to use
     # @param llm_api_key [String] The API key for the LLM
     def initialize(llm:, llm_api_key:)
-      validate_llm!(llm: llm)
+      LLM::Base.validate_llm!(llm: llm)
 
       @llm = llm
       @llm_api_key = llm_api_key
@@ -38,21 +38,21 @@ module Vectorsearch
       :default_dimension
 
     def generate_prompt(question:, context:)
-      "Context:\n" +
-      "#{context}\n" +
-      "---\n" +
-      "Question: #{question}\n" +
-      "---\n" +
-      "Answer:"
-    end
-
-    private
-
-    def validate_llm!(llm:)
-      # TODO: Fix so this works when `llm` value is a string instead of a symbol
-      unless LLM::Base::LLMS.keys.include?(llm)
-        raise ArgumentError, "LLM must be one of #{LLM::Base::LLMS.keys}"
-      end
+      prompt_template = Prompt::FewShotPromptTemplate.new(
+        prefix: "Context:",
+        suffix: "---\nQuestion: {question}\n---\nAnswer:",
+        example_prompt: Prompt::PromptTemplate.new(
+          template: "{context}",
+          input_variables: ["context"]
+        ),
+        examples: [
+          { context: context }
+        ],
+        input_variables: ["question"],
+        example_separator: "\n"
+      )
+
+      prompt_template.format(question: question)
     end
   end
 end

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: langchainrb
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: eqn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
 - !ruby/object:Gem::Dependency
   name: milvus
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: google_search_results
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: weaviate-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -137,13 +165,25 @@ files:
 - README.md
 - Rakefile
 - examples/.keep
+- examples/create_and_manage_few_shot_prompt_templates.rb
+- examples/create_and_manage_prompt_templates.rb
 - examples/store_and_query_with_pinecone.rb
 - examples/store_and_query_with_qdrant.rb
 - examples/store_and_query_with_weaviate.rb
+- lib/agent/base.rb
+- lib/agent/chain_of_thought_agent/chain_of_thought_agent.rb
+- lib/agent/chain_of_thought_agent/chain_of_thought_agent_prompt.json
 - lib/langchain.rb
 - lib/llm/base.rb
 - lib/llm/cohere.rb
 - lib/llm/openai.rb
+- lib/prompt/base.rb
+- lib/prompt/few_shot_prompt_template.rb
+- lib/prompt/loading.rb
+- lib/prompt/prompt_template.rb
+- lib/tool/base.rb
+- lib/tool/calculator.rb
+- lib/tool/serp_api.rb
 - lib/vectorsearch/base.rb
 - lib/vectorsearch/milvus.rb
 - lib/vectorsearch/pinecone.rb