langchainrb 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87647b8a7e2dc49359f3f6d655eda501dcac26ebdd14247ad6c583be8dc1a71c
-  data.tar.gz: fb7b4321caa4ff026439158f5ccfc2ae9e7b515a69c35cba87385f2cb367fa85
+  metadata.gz: 9781999daf45e5fedb0c7a905268866fbefd4581fd35a1a512ebb5844598f2c7
+  data.tar.gz: 93e2161a331151218cb94706827ab1ca2d94cb363613a5117ef7ce0c36cb9469
 SHA512:
-  metadata.gz: 4f80677c43c00e6d50e0494aa79cb7648b9f3878ed8d2a5f4f2dc90e308a3639589f8457a4615821b70b44c5a43ae4f26fcf00d7548684740e4c05dbcc165bf8
-  data.tar.gz: 4722233dbed83d21f2dadff19a9b79a30d8fd208d6e30bd057f018060c602b7f00f0526ee0364823597806388e2a8da48e883a5e6fa77b31490199685644b4d2
+  metadata.gz: 58255ecc90b645cf6b276bee83a385d567122fb8b90ad7a075f4b2ec90ba2f6871156c6e5762b0bd67b259371d1c35b3973fd6b4e631be858ea8a368aac163b7
+  data.tar.gz: ffcaba1dc980b1f3175269a223ebe522bae1a3e17931b1f911adf387f8fc4a32692d45712ab0032e5a9c273ba304d97ca0ce2086978381d17e716efa1941072a

data/.env.example

@@ -5,6 +5,7 @@ HUGGING_FACE_API_KEY=
 MILVUS_URL=
 OPENAI_API_KEY=
 GOOGLE_PALM_API_KEY=
+OPEN_WEATHER_API_KEY=
 PINECONE_API_KEY=
 PINECONE_ENVIRONMENT=
 POSTGRES_URL=

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.5.5] - 2023-06-12
+- [BREAKING] Rename `Langchain::Chat` to `Langchain::Conversation`
+- 🛠️ Tools
+  - Introducing `Langchain::Tool::Weather`, a tool that calls Open Weather API to retrieve the current weather
+
 ## [0.5.4] - 2023-06-10
 - 🔍 Vectorsearch
   - Introducing support for HNSWlib

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    langchainrb (0.5.4)
+    langchainrb (0.5.5)
       colorize (~> 0.8.1)
       tiktoken_ruby (~> 0.0.5)
 
@@ -135,6 +135,7 @@ GEM
       activesupport (>= 3.0)
       graphql
     hashery (2.1.2)
+    hashie (5.0.0)
     hnswlib (0.8.1)
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
@@ -167,6 +168,11 @@ GEM
       racc (~> 1.4)
     nokogiri (1.14.3-x86_64-linux)
       racc (~> 1.4)
+    open-weather-ruby-client (0.3.0)
+      activesupport
+      faraday (>= 1.0.0)
+      faraday_middleware
+      hashie
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
@@ -318,6 +324,7 @@ DEPENDENCIES
   langchainrb!
   milvus (~> 0.9.0)
   nokogiri (~> 1.13)
+  open-weather-ruby-client (~> 0.3.0)
   pdf-reader (~> 1.4)
   pg (~> 1.5)
   pgvector (~> 0.2)

data/README.md

@@ -309,6 +309,7 @@ agent.run(question: "How many users have a name with length greater than 5 in th
 | "database"   | Useful for querying a SQL database |                                                               | `gem "sequel", "~> 5.68.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"` |
+| "weather"  | Calls Open Weather API to retrieve the current weather        |      `ENV["OPEN_WEATHER_API_KEY]` (https://home.openweathermap.org/api_keys)               | `gem "open-weather-ruby-client", "~> 0.3.0"`    |
 | "wikipedia"  | Calls Wikipedia API to retrieve the summary        |                                                               | `gem "wikipedia-client", "~> 1.17.0"`     |
 
 #### Loaders 🚚

data/lib/langchain/{chat.rb → conversation.rb}

@@ -1,11 +1,27 @@
 # frozen_string_literal: true
 
 module Langchain
-  class Chat
-    attr_reader :context
+  #
+  # A high-level API for running a conversation with an LLM.
+  # Currently supports: OpenAI and Google PaLM LLMs.
+  #
+  # Usage:
+  #     llm = Langchain::LLM::OpenAI.new(api_key: "YOUR_API_KEY")
+  #     chat = Langchain::Conversation.new(llm: llm)
+  #     chat.set_context("You are a chatbot from the future")
+  #     chat.message("Tell me about future technologies")
+  #
+  class Conversation
+    attr_reader :context, :examples, :messages
 
+    # Intialize Conversation with a LLM
+    #
+    # @param llm [Object] The LLM to use for the conversation
+    # @param options [Hash] Options to pass to the LLM, like temperature, top_k, etc.
+    # @return [Langchain::Conversation] The Langchain::Conversation instance
     def initialize(llm:, **options)
       @llm = llm
+      @options = options
       @context = nil
       @examples = []
       @messages = []
@@ -36,7 +52,7 @@ module Langchain
     private
 
     def llm_response(prompt)
-      @llm.chat(messages: @messages, context: @context, examples: @examples)
+      @llm.chat(messages: @messages, context: @context, examples: @examples, **@options)
     end
 
     def append_ai_message(message)

data/lib/langchain/tool/weather.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Langchain::Tool
+  class Weather < Base
+    #
+    # A weather tool that gets current weather data
+    #
+    # Current weather data is free for 1000 calls per day (https://home.openweathermap.org/api_keys)
+    # Forecast and historical data require registration with credit card, so not supported yet.
+    #
+    # Gem requirements:
+    #     gem "open-weather-ruby-client", "~> 0.3.0"
+    #     api_key: https://home.openweathermap.org/api_keys
+    #
+    # Usage:
+    #     weather = Langchain::Tool::Weather.new(api_key: "YOUR_API_KEY")
+    #     weather.execute(input: "Boston, MA; imperial")
+    #
+
+    NAME = "weather"
+
+    description <<~DESC
+      Useful for getting current weather data
+    
+      The input to this tool should be a city name followed by the units (imperial, metric, or standard)
+      Usage:
+        Action Input: St Louis, Missouri; metric
+        Action Input: Boston, Massachusetts; imperial
+        Action Input: Dubai, AE; imperial
+        Action Input: Kiev, Ukraine; metric
+    DESC
+
+    attr_reader :client, :units
+
+    #
+    # Initializes the Weather tool
+    #
+    # @param api_key [String] Open Weather API key
+    # @return [Langchain::Tool::Weather] Weather tool
+    #
+    def initialize(api_key:, units: "metric")
+      depends_on "open-weather-ruby-client"
+      require "open-weather-ruby-client"
+
+      OpenWeather::Client.configure do |config|
+        config.api_key = api_key
+        config.user_agent = "Langchainrb Ruby Client"
+      end
+
+      @client = OpenWeather::Client.new
+    end
+
+    # Returns current weather for a city
+    # @param input [String] comma separated city and unit (optional: imperial, metric, or standard)
+    # @return [String] Answer
+    def execute(input:)
+      Langchain.logger.info("[#{self.class.name}]".light_blue + ": Executing for \"#{input}\"")
+
+      input_array = input.split(";")
+      city, units = *input_array.map(&:strip)
+
+      data = client.current_weather(city: city, units: units)
+      weather = data.main.map { |key, value| "#{key} #{value}" }.join(", ")
+      "The current weather in #{data.name} is #{weather}"
+    end
+  end
+end

data/lib/langchain/vectorsearch/chroma.rb

@@ -8,7 +8,7 @@ module Langchain::Vectorsearch
     # Gem requirements: gem "chroma-db", "~> 0.3.0"
     #
     # Usage:
-    # chroma = Langchain::Vectorsearch::Chroma.new(url:, index_name:, llm:, llm_api_key:, api_key: nil)
+    # chroma = Langchain::Vectorsearch::Chroma.new(url:, index_name:, llm:, api_key: nil)
     #
 
     # Initialize the Chroma client

data/lib/langchain/vectorsearch/milvus.rb

@@ -8,9 +8,17 @@ module Langchain::Vectorsearch
     # Gem requirements: gem "milvus", "~> 0.9.0"
     #
     # Usage:
-    # milvus = Langchain::Vectorsearch::Milvus.new(url:, index_name:, llm:, llm_api_key:)
+    # milvus = Langchain::Vectorsearch::Milvus.new(url:, index_name:, llm:)
     #
 
+    #
+    # Initialize the Milvus client
+    #
+    # @param url [String] The URL of the Milvus server
+    # @param api_key [String] The API key to use
+    # @param index_name [String] The name of the index to use
+    # @param llm [Object] The LLM client to use
+    #
     def initialize(url:, index_name:, llm:, api_key: nil)
       depends_on "milvus"
       require "milvus"
@@ -21,6 +29,11 @@ module Langchain::Vectorsearch
       super(llm: llm)
     end
 
+    #
+    # Add a list of texts to the index
+    #
+    # @param texts [Array] The list of texts to add
+    #
     def add_texts(texts:)
       client.entities.insert(
         collection_name: index_name,

data/lib/langchain/vectorsearch/pgvector.rb

@@ -8,7 +8,7 @@ module Langchain::Vectorsearch
     # Gem requirements: gem "pgvector", "~> 0.2"
     #
     # Usage:
-    # pgvector = Langchain::Vectorsearch::Pgvector.new(url:, index_name:, llm:, llm_api_key:)
+    # pgvector = Langchain::Vectorsearch::Pgvector.new(url:, index_name:, llm:)
     #
 
     # The operators supported by the PostgreSQL vector search adapter
@@ -20,10 +20,14 @@ module Langchain::Vectorsearch
 
     attr_reader :operator, :quoted_table_name
 
+    #
+    # Initialize the PostgreSQL client
+    #
     # @param url [String] The URL of the PostgreSQL database
     # @param index_name [String] The name of the table to use for the index
     # @param llm [Object] The LLM client to use
     # @param api_key [String] The API key for the Vectorsearch DB (not used for PostgreSQL)
+    #
     def initialize(url:, index_name:, llm:, api_key: nil)
       require "pg"
       require "pgvector"

data/lib/langchain/vectorsearch/pinecone.rb

@@ -8,14 +8,17 @@ module Langchain::Vectorsearch
     # Gem requirements: gem "pinecone", "~> 0.1.6"
     #
     # Usage:
-    # pinecone = Langchain::Vectorsearch::Pinecone.new(environment:, api_key:, index_name:, llm:, llm_api_key:)
+    # pinecone = Langchain::Vectorsearch::Pinecone.new(environment:, api_key:, index_name:, llm:)
     #
 
+    #
     # Initialize the Pinecone client
+    #
     # @param environment [String] The environment to use
     # @param api_key [String] The API key to use
     # @param index_name [String] The name of the index to use
     # @param llm [Object] The LLM client to use
+    #
     def initialize(environment:, api_key:, index_name:, llm:)
       depends_on "pinecone"
       require "pinecone"

data/lib/langchain/vectorsearch/qdrant.rb

@@ -8,14 +8,17 @@ module Langchain::Vectorsearch
     # Gem requirements: gem "qdrant-ruby", "~> 0.9.0"
     #
     # Usage:
-    # qdrant = Langchain::Vectorsearch::Qdrant.new(url:, api_key:, index_name:, llm:, llm_api_key:)
+    # qdrant = Langchain::Vectorsearch::Qdrant.new(url:, api_key:, index_name:, llm:)
     #
 
+    #
     # Initialize the Qdrant client
+    #
     # @param url [String] The URL of the Qdrant server
     # @param api_key [String] The API key to use
     # @param index_name [String] The name of the index to use
     # @param llm [Object] The LLM client to use
+    #
     def initialize(url:, api_key:, index_name:, llm:)
       depends_on "qdrant-ruby"
       require "qdrant"

data/lib/langchain/vectorsearch/weaviate.rb

@@ -8,14 +8,17 @@ module Langchain::Vectorsearch
     # Gem requirements: gem "weaviate-ruby", "~> 0.8.0"
     #
     # Usage:
-    # weaviate = Langchain::Vectorsearch::Weaviate.new(url:, api_key:, index_name:, llm:, llm_api_key:)
+    # weaviate = Langchain::Vectorsearch::Weaviate.new(url:, api_key:, index_name:, llm:)
     #
 
+    #
     # Initialize the Weaviate adapter
+    #
     # @param url [String] The URL of the Weaviate instance
     # @param api_key [String] The API key to use
     # @param index_name [String] The name of the index to use
     # @param llm [Object] The LLM client to use
+    #
     def initialize(url:, api_key:, index_name:, llm:)
       depends_on "weaviate-ruby"
       require "weaviate"

data/lib/langchain/version.rb

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

data/lib/langchain.rb

@@ -62,7 +62,7 @@ module Langchain
 
   autoload :Loader, "langchain/loader"
   autoload :Data, "langchain/data"
-  autoload :Chat, "langchain/chat"
+  autoload :Conversation, "langchain/conversation"
   autoload :DependencyHelper, "langchain/dependency_helper"
 
   module Agent
@@ -76,6 +76,7 @@ module Langchain
     autoload :Calculator, "langchain/tool/calculator"
     autoload :RubyCodeInterpreter, "langchain/tool/ruby_code_interpreter"
     autoload :SerpApi, "langchain/tool/serp_api"
+    autoload :Weather, "langchain/tool/weather"
     autoload :Wikipedia, "langchain/tool/wikipedia"
     autoload :Database, "langchain/tool/database"
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: langchainrb
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-10 00:00:00.000000000 Z
+date: 2023-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tiktoken_ruby
@@ -248,6 +248,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: open-weather-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -446,7 +460,7 @@ files:
 - lib/langchain/agent/sql_query_agent/sql_query_agent.rb
 - lib/langchain/agent/sql_query_agent/sql_query_agent_answer_prompt.json
 - lib/langchain/agent/sql_query_agent/sql_query_agent_sql_prompt.json
-- lib/langchain/chat.rb
+- lib/langchain/conversation.rb
 - lib/langchain/data.rb
 - lib/langchain/dependency_helper.rb
 - lib/langchain/llm/ai21.rb
@@ -476,6 +490,7 @@ files:
 - lib/langchain/tool/database.rb
 - lib/langchain/tool/ruby_code_interpreter.rb
 - lib/langchain/tool/serp_api.rb
+- lib/langchain/tool/weather.rb
 - lib/langchain/tool/wikipedia.rb
 - lib/langchain/utils/token_length/google_palm_validator.rb
 - lib/langchain/utils/token_length/openai_validator.rb
@@ -497,6 +512,7 @@ metadata:
   homepage_uri: https://rubygems.org/gems/langchainrb
   source_code_uri: https://github.com/andreibondarev/langchainrb
   changelog_uri: https://github.com/andreibondarev/langchainrb/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/langchainrb
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -512,7 +528,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Build LLM-backed Ruby applications with Ruby's LangChain