langchainrb 0.6.6 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9949f3ffd0338c90274f13b9862b0a6b9ec7b717b14b7ccaa8b6b8e0115f621
-  data.tar.gz: 43ebcb26d51b286278d5098ba50defef0c8bd1a897fa744c4519cfa10bdfdf58
+  metadata.gz: 5e8dc16375bc94045a728b37d6d388a8670699c35af4213bc4d16163fbb0047c
+  data.tar.gz: c9695ac8ce5d6bf351afd3148d281a26733f37a43674fae71c3c81c7530cdc2e
 SHA512:
-  metadata.gz: c95f6e104aaa9a8dab30c9e78e342fdf960ccfef332a2737218f3cc186521369e6f03216d5ccd08329d5110cd15ef10e10a3f460caecc02dd50e32b1b60ff8b3
-  data.tar.gz: c8c059c760b361975ea7ba8eb8a7aa24c1dd7dde5264d7d8bdf20da4f7ec80fe3f1cf4f60dd16dd8028638f3335b1e1632b655ae6c4bdd01912d33371892b5a3
+  metadata.gz: 67a532ea9c46961a8636f1332590876f8d5d26e67384789c9a4ab7907c4a2150240a7c9d63ae188d19a269e345ff0dfafcf24ab1cb4a987e4eab5cc2439bbf06
+  data.tar.gz: 333888fdd41e2ce21b369fc0844ca3b181f2db603833bf8cbf8a46e59b8049dcb31a216fb4adcb12fe5a69dc33ec21725131e6e8ce8e7e7633814f5dc7c51c7b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.6.7] - 2023-07-19
+- Support for OpenAI functions
+- Streaming vectorsearch ask() responses
+
 ## [0.6.6] - 2023-07-13
 - Langchain::Chunker::RecursiveText
 - Fixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    langchainrb (0.6.6)
+    langchainrb (0.6.7)
       baran (~> 0.1.6)
       colorize (~> 0.8.1)
       json-schema (~> 4.0.0)
@@ -133,7 +133,7 @@ GEM
       faraday (>= 1.0)
       faraday_middleware
       graphql-client
-    graphql (2.0.23)
+    graphql (2.0.24)
     graphql-client (0.18.0)
       activesupport (>= 3.0)
       graphql
@@ -264,7 +264,7 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-next-core (0.15.3)
-    ruby-openai (4.0.0)
+    ruby-openai (4.1.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
     ruby-progressbar (1.13.0)
@@ -299,7 +299,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    weaviate-ruby (0.8.3)
+    weaviate-ruby (0.8.4)
       faraday (~> 1)
       faraday_middleware (~> 1)
       graphlient (~> 0.6.0)
@@ -344,7 +344,7 @@ DEPENDENCIES
   roo (~> 2.10.0)
   rspec (~> 3.0)
   rubocop
-  ruby-openai (~> 4.0.0)
+  ruby-openai (~> 4.1.0)
   safe_ruby (~> 1.0.4)
   sequel (~> 5.68.0)
   standardrb

data/README.md

@@ -145,6 +145,27 @@ openai.embed(text: "foo bar")
 openai.complete(prompt: "What is the meaning of life?")
 ```
 
+##### Open AI Function calls support
+
+Conversation support
+
+```ruby
+chat = Langchain::Conversation.new(llm: openai)
+```
+```ruby
+chat.set_context("You are the climate bot")
+chat.set_functions(functions)
+```
+
+qdrant:
+
+```ruby
+client.llm.functions = functions
+client.llm.complete_response = true
+```
+
+`complete_response` will return the entire choices data from the gpt response
+
 #### Cohere
 Add `gem "cohere-ruby", "~> 0.9.3"` to your Gemfile.
 

data/examples/open_ai_function_calls.rb

@@ -0,0 +1,41 @@
+require "langchain"
+require "dotenv/load"
+
+functions = [
+  {
+    name: "get_current_weather",
+    description: "Get the current weather in a given location",
+    parameters: {
+      type: :object,
+      properties: {
+        location: {
+          type: :string,
+          description: "The city and state, e.g. San Francisco, CA"
+        },
+        unit: {
+          type: "string",
+          enum: %w[celsius fahrenheit]
+        }
+      },
+      required: ["location"]
+    }
+  }
+]
+
+openai = Langchain::LLM::OpenAI.new(
+  api_key: ENV["OPENAI_API_KEY"],
+  default_options: {
+    chat_completion_model_name: "gpt-3.5-turbo-16k"
+  }
+)
+
+chat = Langchain::Conversation.new(llm: openai)
+
+chat.set_context("You are the climate bot")
+chat.set_functions(functions)
+
+DONE = %w[done end eof exit].freeze
+
+user_message = "what's the weather in NYC?"
+
+puts chat.message(user_message)

data/examples/open_ai_qdrant_function_calls.rb

@@ -0,0 +1,43 @@
+require "langchain"
+require "dotenv/load"
+
+functions = [
+  {
+    name: "create_rails_controller",
+    description: "gives a command to create a rails controller",
+    parameters: {
+      type: :object,
+      properties: {
+        controller_name: {
+          type: :string,
+          description: "the controller name, e.g. users_controller"
+        },
+        unit: {
+          type: "string",
+          enum: %w[celsius fahrenheit]
+        }
+      },
+      required: ["controller_name"]
+    }
+  }
+]
+
+openai = Langchain::LLM::OpenAI.new(
+  api_key: ENV["OPENAI_API_KEY"],
+  default_options: {
+    chat_completion_model_name: "gpt-3.5-turbo-16k"
+  }
+)
+
+client = Langchain::Vectorsearch::Qdrant.new(
+  url: ENV["QDRANT_URL"],
+  api_key: ENV["QDRANT_API_KEY"],
+  index_name: ENV["QDRANT_INDEX"],
+  llm: openai
+)
+
+client.llm.functions = functions
+client.llm.complete_response = true
+chat = client.ask(question: "create a users_controller")
+
+puts chat

data/lib/langchain/conversation.rb

@@ -37,6 +37,11 @@ module Langchain
       @block = block
     end
 
+    def set_functions(functions)
+      @llm.functions = functions
+      @llm.complete_response = true
+    end
+
     # Set the context of the conversation. Usually used to set the model's persona.
     # @param message [String] The context of the conversation
     def set_context(message)

data/lib/langchain/llm/openai.rb

@@ -19,6 +19,8 @@ module Langchain::LLM
     }.freeze
     LENGTH_VALIDATOR = Langchain::Utils::TokenLength::OpenAIValidator
 
+    attr_accessor :functions, :complete_response
+
     def initialize(api_key:, llm_options: {}, default_options: {})
       depends_on "ruby-openai"
       require "openai"
@@ -115,20 +117,25 @@ module Langchain::LLM
 
       parameters = compose_parameters @defaults[:chat_completion_model_name], options
       parameters[:messages] = compose_chat_messages(prompt: prompt, messages: messages, context: context, examples: examples)
-      parameters[:max_tokens] = validate_max_tokens(parameters[:messages], parameters[:model])
+
+      if functions
+        parameters[:functions] = functions
+      else
+        parameters[:max_tokens] = validate_max_tokens(parameters[:messages], parameters[:model])
+      end
 
       if (streaming = block_given?)
         parameters[:stream] = proc do |chunk, _bytesize|
-          yield chunk.dig("choices", 0, "delta", "content")
+          yield chunk if complete_response
+          yield chunk.dig("choices", 0, "delta", "content") if !complete_response
         end
       end
 
       response = client.chat(parameters: parameters)
-
       raise Langchain::LLM::ApiError.new "Chat completion failed: #{response.dig("error", "message")}" if !response.empty? && response.dig("error")
-
       unless streaming
-        response.dig("choices", 0, "message", "content")
+        return response.dig("choices", 0, "message", "content") if !complete_response
+        return response if complete_response
       end
     end
 

data/lib/langchain/vectorsearch/chroma.rb

@@ -113,8 +113,9 @@ module Langchain::Vectorsearch
 
     # Ask a question and return the answer
     # @param question [String] The question to ask
+    # @yield [String] Stream responses back one String at a time
     # @return [String] The answer to the question
-    def ask(question:)
+    def ask(question:, &block)
       search_results = similarity_search(query: question)
 
       context = search_results.map do |result|
@@ -125,7 +126,7 @@ module Langchain::Vectorsearch
 
       prompt = generate_prompt(question: question, context: context)
 
-      llm.chat(prompt: prompt)
+      llm.chat(prompt: prompt, &block)
     end
 
     private

data/lib/langchain/vectorsearch/pgvector.rb

@@ -136,8 +136,9 @@ module Langchain::Vectorsearch
 
     # Ask a question and return the answer
     # @param question [String] The question to ask
+    # @yield [String] Stream responses back one String at a time
     # @return [String] The answer to the question
-    def ask(question:)
+    def ask(question:, &block)
       search_results = similarity_search(query: question)
 
       context = search_results.map do |result|
@@ -147,7 +148,7 @@ module Langchain::Vectorsearch
 
       prompt = generate_prompt(question: question, context: context)
 
-      llm.chat(prompt: prompt)
+      llm.chat(prompt: prompt, &block)
     end
   end
 end

data/lib/langchain/vectorsearch/pinecone.rb

@@ -139,8 +139,9 @@ module Langchain::Vectorsearch
     # @param question [String] The question to ask
     # @param namespace [String] The namespace to search in
     # @param filter [String] The filter to use
+    # @yield [String] Stream responses back one String at a time
     # @return [String] The answer to the question
-    def ask(question:, namespace: "", filter: nil)
+    def ask(question:, namespace: "", filter: nil, &block)
       search_results = similarity_search(query: question, namespace: namespace, filter: filter)
 
       context = search_results.map do |result|
@@ -150,7 +151,7 @@ module Langchain::Vectorsearch
 
       prompt = generate_prompt(question: question, context: context)
 
-      llm.chat(prompt: prompt)
+      llm.chat(prompt: prompt, &block)
     end
 
     # Pinecone index

data/lib/langchain/vectorsearch/qdrant.rb

@@ -112,8 +112,9 @@ module Langchain::Vectorsearch
 
     # Ask a question and return the answer
     # @param question [String] The question to ask
+    # @yield [String] Stream responses back one String at a time
     # @return [String] The answer to the question
-    def ask(question:)
+    def ask(question:, &block)
       search_results = similarity_search(query: question)
 
       context = search_results.map do |result|
@@ -123,7 +124,7 @@ module Langchain::Vectorsearch
 
       prompt = generate_prompt(question: question, context: context)
 
-      llm.chat(prompt: prompt)
+      llm.chat(prompt: prompt, &block)
     end
   end
 end

data/lib/langchain/vectorsearch/weaviate.rb

@@ -124,8 +124,9 @@ module Langchain::Vectorsearch
 
     # Ask a question and return the answer
     # @param question [String] The question to ask
+    # @yield [String] Stream responses back one String at a time
     # @return [Hash] The answer
-    def ask(question:)
+    def ask(question:, &block)
       search_results = similarity_search(query: question)
 
       context = search_results.map do |result|
@@ -135,7 +136,7 @@ module Langchain::Vectorsearch
 
       prompt = generate_prompt(question: question, context: context)
 
-      llm.chat(prompt: prompt)
+      llm.chat(prompt: prompt, &block)
     end
 
     private

data/lib/langchain/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: langchainrb
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.6.7
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: baran
@@ -408,14 +408,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: safe_ruby
   requirement: !ruby/object:Gem::Requirement
@@ -493,6 +493,8 @@ files:
 - examples/create_and_manage_prompt_templates.rb
 - examples/create_and_manage_prompt_templates_using_structured_output_parser.rb
 - examples/llama_cpp.rb
+- examples/open_ai_function_calls.rb
+- examples/open_ai_qdrant_function_calls.rb
 - examples/pdf_store_and_query_with_chroma.rb
 - examples/store_and_query_with_pinecone.rb
 - examples/store_and_query_with_qdrant.rb
@@ -589,7 +591,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