chroma-db 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81e14d1d408077096602201fb386612b9d511a0294726efcba2942491a164763
-  data.tar.gz: bc06c130d7ad215d5a2264527813e10900bda1b6d8975de8c59712a7cb438a99
+  metadata.gz: c10027541e8648c0ba4e6ebe73fef4fdb75d55a1c04c0e59bcd681a1b2108598
+  data.tar.gz: fb5a8a590885bc26fcabfd379b6ee5aaada355f99e05ab50eca32280a80bccea
 SHA512:
-  metadata.gz: 109074182103666dca9fb201c0dc473220b0a5ee6849ff3022203a4debea1388347b98d74a0ce14d75361953a1c70b6c1a24ab62387c317e394712fe677e082a
-  data.tar.gz: f075cf97229240b6d38ff72946188ec436a0010b8f0925d1b30a63e6c2b3dc0b6bf8436a16d0c3abf5c89cabe64951b73bd10eb036b95a3ae9a40b8f2c778cdd
+  metadata.gz: 3665995e6028599eae9daf8f546e2923075b441596b4f5854bfb33901405ea8c59c47d8ec237d1c079e8e9b68115181fb2cfb4db5fd794db1e2a5a8cd61bf755
+  data.tar.gz: 1f1a9534d6422b34b7d7f0a8a6cb1a4f331076e44dc030e46fcbf7af971b9181747b1fa38a616cf3c44636010a54ea0eaba357dd3f7878f94cf51c40d883d854

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.6.0] 2023-06-05
+
+- Fix failure to rescue from API call exceptions.
+- Fix embedding loading into Embedding resource.
+
+## [0.5.0] 2023-05-26
+
+- Adds method `get_or_create` to Collection class.
+
 ## [0.4.0] 2023-05-23
 
 - This version implements Chroma's API change where Collection uses its collection id for many operations. Changes in the

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chroma-db (0.4.0)
+    chroma-db (0.6.0)
       dry-monads (~> 1.6)
       ruby-next (>= 0.15.0)
 

data/lib/.rbnext/2.7/chroma/resources/collection.rb

@@ -43,12 +43,12 @@ module Chroma
           include: include
         }
 
-        result = self.class.execute_request(:post, "#{Chroma.api_url}/collections/#{name}/query", payload)
+        result = self.class.execute_request(:post, "#{Chroma.api_url}/collections/#{id}/query", payload)
 
         if result.success?
           build_embeddings_response(result.success.body)
         else
-          raise_failure_error(result)
+          self.class.raise_failure_error(result)
         end
       end
 
@@ -92,7 +92,7 @@ module Chroma
         if result.success?
           build_embeddings_response(result.success.body)
         else
-          raise_failure_error(result)
+          self.class.raise_failure_error(result)
         end
       end
 
@@ -116,7 +116,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Delete embeddings from the collection.
@@ -142,7 +142,7 @@ module Chroma
 
         return result.success.body if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Update one or many embeddings to the collection.
@@ -166,7 +166,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Upsert (insert or update) one or many embeddings to the collection.
@@ -177,8 +177,8 @@ module Chroma
       #
       #   collection = Chroma::Resource::Collection.get("ruby-documentation")
       #   embeddings = [
-      #     Embedding.new(id: "Array#fetch", embeddings[9.8, 2.3, 2.9], metadata: {url: "https://..."}),
-      #     Embedding.new(id: "Array#select", embeddings[5.6, 3.1, 4.7], metadata: {url: "https://..."})
+      #     Embedding.new(id: "Array#fetch", embeddings: [9.8, 2.3, 2.9], metadata: {url: "https://..."}),
+      #     Embedding.new(id: "Array#select", embeddings: [5.6, 3.1, 4.7], metadata: {url: "https://..."})
       #   ]
       #   collection.upsert()
       #
@@ -193,7 +193,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Count the number of embeddings in a collection.
@@ -209,7 +209,7 @@ module Chroma
 
         return result.success.body if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Modify the name and metadata of the current collection.
@@ -233,7 +233,7 @@ module Chroma
           @name = new_name
           @metadata = new_metadata
         else
-          raise_failure_error(result)
+          self.class.raise_failure_error(result)
         end
       end
 
@@ -250,7 +250,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Create a new collection on the database.
@@ -298,6 +298,31 @@ module Chroma
         end
       end
 
+      # Get or create a collection on the database.
+      #
+      # name - The name of the collection. Name needs to be between 3-63 characters, starts and ends
+      #   with an alphanumeric character, contains only alphanumeric characters, underscores or hyphens (-), and
+      #   contains no two consecutive periods
+      # metadata - A hash of additional metadata associated with the collection, this is used if collection is created.
+      #
+      # Examples
+      #
+      #   collection = Chorma::Resources::Collection.get_or_create("ruby-documentation", {source: "Ruby lang website"})
+      #
+      # Returns the created collection object.
+      def self.get_or_create(name, metadata = nil)
+        payload = {name: name, metadata: metadata, get_or_create: true}
+
+        result = execute_request(:post, "#{Chroma.api_url}/collections", payload)
+
+        if result.success?
+          data = result.success.body
+          new(id: data["id"], name: data["name"], metadata: data["metadata"])
+        else
+          raise_failure_error(result)
+        end
+      end
+
       # Retrieves all collections in the database.
       #
       # Examples
@@ -351,7 +376,6 @@ module Chroma
           raise Chroma::APIError.new(result.failure.body, status: result.failure.status, body: result.failure.body)
         end
       end
-      private_class_method :raise_failure_error
 
       private
 
@@ -372,7 +396,7 @@ module Chroma
         Chroma::Util.log_debug("Building embeddings from #{result.inspect}")
 
         result_ids = result.fetch("ids", []).flatten
-        result_embeddings = (result.dig("embeddings") || []).flatten
+        result_embeddings = result.dig("embeddings") || []
         result_documents = (result.dig("documents") || []).flatten
         result_metadatas = (result.dig("metadatas") || []).flatten
         result_distances = (result.dig("distances") || []).flatten

data/lib/.rbnext/3.1/chroma/resources/collection.rb

@@ -43,12 +43,12 @@ module Chroma
           include: include
         }
 
-        result = self.class.execute_request(:post, "#{Chroma.api_url}/collections/#{name}/query", payload)
+        result = self.class.execute_request(:post, "#{Chroma.api_url}/collections/#{id}/query", payload)
 
         if result.success?
           build_embeddings_response(result.success.body)
         else
-          raise_failure_error(result)
+          self.class.raise_failure_error(result)
         end
       end
 
@@ -92,7 +92,7 @@ module Chroma
         if result.success?
           build_embeddings_response(result.success.body)
         else
-          raise_failure_error(result)
+          self.class.raise_failure_error(result)
         end
       end
 
@@ -116,7 +116,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Delete embeddings from the collection.
@@ -142,7 +142,7 @@ module Chroma
 
         return result.success.body if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Update one or many embeddings to the collection.
@@ -166,7 +166,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Upsert (insert or update) one or many embeddings to the collection.
@@ -177,8 +177,8 @@ module Chroma
       #
       #   collection = Chroma::Resource::Collection.get("ruby-documentation")
       #   embeddings = [
-      #     Embedding.new(id: "Array#fetch", embeddings[9.8, 2.3, 2.9], metadata: {url: "https://..."}),
-      #     Embedding.new(id: "Array#select", embeddings[5.6, 3.1, 4.7], metadata: {url: "https://..."})
+      #     Embedding.new(id: "Array#fetch", embeddings: [9.8, 2.3, 2.9], metadata: {url: "https://..."}),
+      #     Embedding.new(id: "Array#select", embeddings: [5.6, 3.1, 4.7], metadata: {url: "https://..."})
       #   ]
       #   collection.upsert()
       #
@@ -193,7 +193,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Count the number of embeddings in a collection.
@@ -209,7 +209,7 @@ module Chroma
 
         return result.success.body if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Modify the name and metadata of the current collection.
@@ -233,7 +233,7 @@ module Chroma
           @name = new_name
           @metadata = new_metadata
         else
-          raise_failure_error(result)
+          self.class.raise_failure_error(result)
         end
       end
 
@@ -250,7 +250,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Create a new collection on the database.
@@ -298,6 +298,31 @@ module Chroma
         end
       end
 
+      # Get or create a collection on the database.
+      #
+      # name - The name of the collection. Name needs to be between 3-63 characters, starts and ends
+      #   with an alphanumeric character, contains only alphanumeric characters, underscores or hyphens (-), and
+      #   contains no two consecutive periods
+      # metadata - A hash of additional metadata associated with the collection, this is used if collection is created.
+      #
+      # Examples
+      #
+      #   collection = Chorma::Resources::Collection.get_or_create("ruby-documentation", {source: "Ruby lang website"})
+      #
+      # Returns the created collection object.
+      def self.get_or_create(name, metadata = nil)
+        payload = {name: name, metadata: metadata, get_or_create: true}
+
+        result = execute_request(:post, "#{Chroma.api_url}/collections", payload)
+
+        if result.success?
+          data = result.success.body
+          new(id: data["id"], name: data["name"], metadata: data["metadata"])
+        else
+          raise_failure_error(result)
+        end
+      end
+
       # Retrieves all collections in the database.
       #
       # Examples
@@ -347,7 +372,6 @@ module Chroma
           raise Chroma::APIError.new(result.failure.body, status: result.failure.status, body: result.failure.body)
         end
       end
-      private_class_method :raise_failure_error
 
       private
 
@@ -368,7 +392,7 @@ module Chroma
         Chroma::Util.log_debug("Building embeddings from #{result.inspect}")
 
         result_ids = result.fetch("ids", []).flatten
-        result_embeddings = (result.dig("embeddings") || []).flatten
+        result_embeddings = result.dig("embeddings") || []
         result_documents = (result.dig("documents") || []).flatten
         result_metadatas = (result.dig("metadatas") || []).flatten
         result_distances = (result.dig("distances") || []).flatten

data/lib/chroma/resources/collection.rb

@@ -48,7 +48,7 @@ module Chroma
         if result.success?
           build_embeddings_response(result.success.body)
         else
-          raise_failure_error(result)
+          self.class.raise_failure_error(result)
         end
       end
 
@@ -92,7 +92,7 @@ module Chroma
         if result.success?
           build_embeddings_response(result.success.body)
         else
-          raise_failure_error(result)
+          self.class.raise_failure_error(result)
         end
       end
 
@@ -116,7 +116,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Delete embeddings from the collection.
@@ -142,7 +142,7 @@ module Chroma
 
         return result.success.body if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Update one or many embeddings to the collection.
@@ -166,7 +166,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Upsert (insert or update) one or many embeddings to the collection.
@@ -177,8 +177,8 @@ module Chroma
       #
       #   collection = Chroma::Resource::Collection.get("ruby-documentation")
       #   embeddings = [
-      #     Embedding.new(id: "Array#fetch", embeddings[9.8, 2.3, 2.9], metadata: {url: "https://..."}),
-      #     Embedding.new(id: "Array#select", embeddings[5.6, 3.1, 4.7], metadata: {url: "https://..."})
+      #     Embedding.new(id: "Array#fetch", embeddings: [9.8, 2.3, 2.9], metadata: {url: "https://..."}),
+      #     Embedding.new(id: "Array#select", embeddings: [5.6, 3.1, 4.7], metadata: {url: "https://..."})
       #   ]
       #   collection.upsert()
       #
@@ -193,7 +193,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Count the number of embeddings in a collection.
@@ -209,7 +209,7 @@ module Chroma
 
         return result.success.body if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Modify the name and metadata of the current collection.
@@ -233,7 +233,7 @@ module Chroma
           @name = new_name
           @metadata = new_metadata
         else
-          raise_failure_error(result)
+          self.class.raise_failure_error(result)
         end
       end
 
@@ -250,7 +250,7 @@ module Chroma
 
         return true if result.success?
 
-        raise_failure_error(result)
+        self.class.raise_failure_error(result)
       end
 
       # Create a new collection on the database.
@@ -298,6 +298,31 @@ module Chroma
         end
       end
 
+      # Get or create a collection on the database.
+      #
+      # name - The name of the collection. Name needs to be between 3-63 characters, starts and ends
+      #   with an alphanumeric character, contains only alphanumeric characters, underscores or hyphens (-), and
+      #   contains no two consecutive periods
+      # metadata - A hash of additional metadata associated with the collection, this is used if collection is created.
+      #
+      # Examples
+      #
+      #   collection = Chorma::Resources::Collection.get_or_create("ruby-documentation", {source: "Ruby lang website"})
+      #
+      # Returns the created collection object.
+      def self.get_or_create(name, metadata = nil)
+        payload = {name:, metadata:, get_or_create: true}
+
+        result = execute_request(:post, "#{Chroma.api_url}/collections", payload)
+
+        if result.success?
+          data = result.success.body
+          new(id: data["id"], name: data["name"], metadata: data["metadata"])
+        else
+          raise_failure_error(result)
+        end
+      end
+
       # Retrieves all collections in the database.
       #
       # Examples
@@ -347,7 +372,6 @@ module Chroma
           raise Chroma::APIError.new(result.failure.body, status: result.failure.status, body: result.failure.body)
         end
       end
-      private_class_method :raise_failure_error
 
       private
 
@@ -368,7 +392,7 @@ module Chroma
         Chroma::Util.log_debug("Building embeddings from #{result.inspect}")
 
         result_ids = result.fetch("ids", []).flatten
-        result_embeddings = (result.dig("embeddings") || []).flatten
+        result_embeddings = result.dig("embeddings") || []
         result_documents = (result.dig("documents") || []).flatten
         result_metadatas = (result.dig("metadatas") || []).flatten
         result_distances = (result.dig("distances") || []).flatten

data/lib/chroma/util.rb

@@ -63,7 +63,7 @@ module Chroma
     def self.log_internal(message, data = {}, level:, logger:)
       data_str = data.reject { |_k, v| v.nil? }.map { |(k, v)| "#{k}=#{v}" }.join(" ")
 
-      logger&.log(level, "message=#{message} #{data_str}".strip)
+      logger&.add(level, "message=#{message} #{data_str}".strip)
     end
     private_class_method :log_internal
   end

data/lib/chroma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chroma
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chroma-db
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mario Alberto Chávez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: ruby-next-core
+  name: ruby-next
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="