chroma-db 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81e14d1d408077096602201fb386612b9d511a0294726efcba2942491a164763
-  data.tar.gz: bc06c130d7ad215d5a2264527813e10900bda1b6d8975de8c59712a7cb438a99
+  metadata.gz: 2d7ef50774b1e00c56ee2f67670afc3b7d2fd0760ace64627985ed6460701b7b
+  data.tar.gz: 9e4f771c7ab2fe8b3ceead3efa3dbe3e03155d2ab8823c895b90e72ac78f7f9b
 SHA512:
-  metadata.gz: 109074182103666dca9fb201c0dc473220b0a5ee6849ff3022203a4debea1388347b98d74a0ce14d75361953a1c70b6c1a24ab62387c317e394712fe677e082a
-  data.tar.gz: f075cf97229240b6d38ff72946188ec436a0010b8f0925d1b30a63e6c2b3dc0b6bf8436a16d0c3abf5c89cabe64951b73bd10eb036b95a3ae9a40b8f2c778cdd
+  metadata.gz: 3dee2d6604b17ac0baf2872ba0b807ebe7acafdbce4c3fdbc1453f737161e1916b30fe80e7a09daf34d0ced994a918d604e74b4aac355381fff1f89b635fc2ce
+  data.tar.gz: bb8a63c2937041c4123d08f89704fa755a2096724e57176e37c8fed2d3902d7c6df2889c621cb7ced4372938a70870f47525560c09615c7d8d48520192d3ae4f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [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.5.0)
       dry-monads (~> 1.6)
       ruby-next (>= 0.15.0)
 

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

@@ -43,7 +43,7 @@ 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)
@@ -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

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

@@ -43,7 +43,7 @@ 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)
@@ -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

data/lib/chroma/resources/collection.rb

@@ -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

data/lib/chroma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chroma
-  VERSION = "0.4.0"
+  VERSION = "0.5.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.5.0
 platform: ruby
 authors:
 - Mario Alberto Chávez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads