speaky 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24debd882e7071392c95c5a0f916fd0354f933ced5ce94f6a260e11c9766d5f9
-  data.tar.gz: 9e2238fb22c50493a97cde8799c645582ecd4f1527d7f8420adeed4296165479
+  metadata.gz: b6be1d021d8ebe259d6aa37fe46dc536e8be03b0e4b19309ad06733625bb91ff
+  data.tar.gz: 5a5b658cd9ea7878362d436cee77b322be437e0a6bca88db844eb56cd06719af
 SHA512:
-  metadata.gz: '009c0303f434bcf2e15fef4f047da10db442ef9ec1a1d4c691e411ddfe34abe3a27e9820ae685978b49e62fdfe0af0c8554bd637a5b19cb709b90d7afd7a1c75'
-  data.tar.gz: 411eeca77146779120e94f6f62e9e69bad488ca4f8ea4f4838bfc586e902411143487fdeb5ddb35e02f80366a34f777bc64c7b0e9030077ba2c9c3b3d6e72135
+  metadata.gz: 28e149649e103d758b87dbb73b3417f1fbdf8e0e73838b24f602fc17204fc2a972fee798eed57aa9c0b92d30ffbeae18047eaa845e248af1355dce1f72b006ed
+  data.tar.gz: ca90c2c737d2f2e151c2f35a8b2b429f116aeb386c02951aa87e119635d0f06cf86fbd1ab9dc4764014d5c830998d6fd9299dee00d4877282fcaa567f4e961dd

data/README.md

@@ -62,8 +62,6 @@ class MyModel < ApplicationRecord
   end
 
   # Add any callbacks that should update the model instance data in the vector store.
-  after_create :create_for_speaky
-  after_update :update_for_speaky
   after_save :save_for_speaky
   after_destroy :destroy_for_speaky
 end

data/lib/speaky/concern.rb

@@ -11,7 +11,7 @@ module Speaky
       self.to_json
     end
 
-    def create_for_speaky
+    def save_for_speaky
       begin
         Speaky.vectorstore.add(self.id, self.as_speaky)
       rescue StandardError => e
@@ -21,16 +21,6 @@ module Speaky
       end
     end
 
-    def update_for_speaky
-      begin
-        Speaky.vectorstore.update(self.id, self.as_speaky)
-      rescue StandardError => e
-        Rails.logger.error(e)
-        errors.add(:base, 'Failed to update for speaky')
-        raise ActiveRecord::Rollback
-      end
-    end
-
     def destroy_for_speaky
       begin
         Speaky.vectorstore.remove(self.id)
@@ -40,15 +30,5 @@ module Speaky
         raise ActiveRecord::Rollback
       end
     end
-
-    def save_for_speaky
-      ActiveRecord::Base.transaction do
-        if self.new_record?
-          create_for_speaky
-        else
-          update_for_speaky
-        end
-      end
-    end
   end
 end

data/lib/speaky/vectorstore_base.rb

@@ -12,24 +12,28 @@ module Speaky
 
     # Add a vector to the vectorstore.
     # NOTE: If the vector already exists, it will be updated.
+    # Returns a boolean.
     def add(id, data)
       raise NotImplementedError
     end
 
-    # Update a vector in the vectorstore.
-    # NOTE: If the vector does not exist, it will be added.
-    def update(id, data)
-      raise NotImplementedError
-    end
-
     # Remove a vector from the vectorstore.
     # NOTE: If the vector does not exist, it will be ignored.
+    # Returns a boolean.
     def remove(id)
       raise NotImplementedError
     end
 
+    # Query the vectorstore with a question.
+    # Returns a string.
     def query(question)
       raise NotImplementedError
     end
+
+    # Reset the vectorstore.
+    # Returns a boolean.
+    def reset
+      raise NotImplementedError
+    end
   end
 end

data/lib/speaky/vectorstore_qdrant.rb

@@ -18,26 +18,8 @@ module Speaky
         api_key: @config[:api_key]
       )
 
-      # create collection if it doesn't exist
-      collections_get = @client.collections.get(collection_name: @config[:collection_name])
-      if !collections_get || collections_get.dig('status') != 'ok'
-        collections_create = @client.collections.create(
-          collection_name: @config[:collection_name],
-          vectors: {
-            distance: "Cosine",
-            size: 1536
-          }
-        )
-        if !collections_create || collections_create.dig('status') != 'ok'
-          raise 'Failed to create collection'
-        end
-      end
-
-      # create index for field "id" in collection
-      collections_create_index = @client.collections.create_index(collection_name: @config[:collection_name], field_name: 'id', field_schema: 'keyword')
-      if !collections_create_index || collections_create_index.dig('status') != 'ok'
-        raise 'Failed to create index for field "id" on collection'
-      end
+      # create collection
+      create_collection
     end
 
     def add(id, data)
@@ -64,10 +46,6 @@ module Speaky
       true
     end
 
-    def update(id, data)
-      add(id, data)
-    end
-
     def remove(id)
       points_delete = @client.points.delete(
         collection_name: @config[:collection_name],
@@ -98,5 +76,40 @@ module Speaky
 
       points_search.dig('result').first.dig('payload', 'content')
     end
+
+    def reset
+      collections_delete = @client.collections.delete(collection_name: @config[:collection_name])
+      if !collections_delete || collections_delete.dig('status') != 'ok'
+        raise 'Failed to delete collection'
+      end
+
+      create_collection
+    end
+
+    private
+
+    def create_collection
+      collections_get = @client.collections.get(collection_name: @config[:collection_name])
+      if !collections_get || collections_get.dig('status') != 'ok'
+        collections_create = @client.collections.create(
+          collection_name: @config[:collection_name],
+          vectors: {
+            distance: "Cosine",
+            size: 1536
+          }
+        )
+        if !collections_create || collections_create.dig('status') != 'ok'
+          raise 'Failed to create collection'
+        end
+      end
+
+      # create index for field "id" in collection
+      collections_create_index = @client.collections.create_index(collection_name: @config[:collection_name], field_name: 'id', field_schema: 'keyword')
+      if !collections_create_index || collections_create_index.dig('status') != 'ok'
+        raise 'Failed to create index for field "id" on collection'
+      end
+
+      true
+    end
   end
 end

data/lib/speaky/version.rb

@@ -1,3 +1,3 @@
 module Speaky
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

data/lib/speaky.rb

@@ -71,6 +71,7 @@ module Speaky
     #
     # Example of usage:
     # Speaky.ask("What is the capital of France?")
+    # Speaky.ask("What is the capital of France?", template: "You are an AI assistant. You are asked a question and you provide an answer. Use the provided context to generate the answer to the question. Context: {{context}} Question: {{question}}")
     def ask(question, template: nil, **other_params)
       # load template
       default_template = <<~TEMPLATE
@@ -97,5 +98,29 @@ module Speaky
       # ask the question
       llm.chat(prompt)
     end
+
+    # This is a method that re-embeds all Rails models into the vectorstore.
+    #
+    # Example of usage:
+    # Speaky.embed!
+    def embed!
+      # reset the vectorstore
+      vectorstore.reset
+
+      # re-embed all rails models that include the Concern module
+      Rails.application.eager_load!
+      rails_models = ActiveRecord::Base.descendants
+      rails_models.each do |rails_model|
+        next unless rails_model.instance_methods.include?(:save_for_speaky)
+
+        rails_model.find_in_batches do |batch|
+          batch.each do |record|
+            record.save_for_speaky
+          end
+        end
+      end
+
+      true
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: speaky
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Gregorio Galante