chromable 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d33a705c79d42fb0495bb63e4ad7d04e8e3eea823400ea213f362af3e4ce09c8
-  data.tar.gz: d18bc615f1a6b22530d76b06b471e07688be422a9af55a92d81419ae48eb4d84
+  metadata.gz: ad740d4c1d70642aa0e03518c74cb5e2b77a68df923a9e46e0797eb42908c312
+  data.tar.gz: 4cdb45e1599c5f579082cac30ff9c3887adaee9921d2bf73f20b6f96401769cd
 SHA512:
-  metadata.gz: cfc65982c4f7952170630630eba0c6bf2bdc7708fae70727cb013d1cc1fe2b88b55e2bf08d9e0231864a0790373db2dfb1db95584c8ed328f0131c9e6a4c8d10
-  data.tar.gz: 6a0b4a7af862ada818d888ed6ae672a23d85057726df9da40f3c715cd1c80fa71ebfac10e00833dd0cf9908b678d3746d3ead9d9cc6f73fc4ae23436a1e3a13e
+  metadata.gz: 19ee5d2e13a7b61962442766faa52f52930acc221b346ac91609eab01c1c9cb6aad01bfd96c444451925434c39ede78d7b949923a0824ef7ae89276b11c49869
+  data.tar.gz: 8de31a2f2b16402acef0d391e39a1049622dcbc3a69968ce0e8485492e1acbb7dae77ab88ae782bc1ef07ae42a43102929e5a47791a8c5443dd67f758e054c4b

data/README.md

@@ -58,28 +58,32 @@ The only required option for `chromable` is `document:`.
 
 At this point, `chromable` will create, update, and destroy the ChromaDB embeddings for your objects based on Rails `after_save` and `after_destroy` callbacks.
 
-To interact with the ChromaDB collection, `chromable` provides `Model.query` method to query the collection and `Model.collection` method to access the collection directly.
+To interact with the ChromaDB collection, `chromable` provides:
+- `Model.query` to query the collection using similar API used in `chroma-db` gem, except for accepting `text:` instead of `query_embeddings:`. Extra arguments will be passed to the `embedder:` as `options`. Behind the scenes, `Model.query` will embed the given `text:`, then query the collection, and return the closest `results:` records.
+- `Model.collection` to access the collection directly.
+- `Model.delete_collection` to delete the entire collection.
 
 ```ruby
 puts Post.collection.count # Gets the number of documents inside the collection. Should always match Post.count.
 
 Post.query(
-  query: params[:query],
+  text: params[:query],
   results: 20,
   where: chroma_search_filters,
   is_query: true # `is_query` here will be passed to `Post.embed` as an option.
 )
-```
 
-`Model.query` accepts the same arguments accepted by `chroma-db` gem `query` method. Extra arguments will be passed to the `embedder:` as `options`. Behind the scenes, `Model.query` will embed the given `query:` text, then query the collection, and return the closest `results:` records.
+Post.first.neighbors(results: 20) # => [#<Post:0x0000ffff9e0b5f10 id: "0beb0f98, ...>, ...]
+```
 
 Also, `chromable` provides the following methods for each model instance:
 
 - `embedding`: Retrieves the instance's ChromaDB embedding object.
 - `upsert_embedding`: Creates or updates the instance's ChromaDB embedding object.
 - `destroy_embedding`: Destroys the instance's ChromaDB embedding object.
+- `neighbors`: Gets the closest `results:` records to the current record.
 
-All these methods (including `Model.query` and `Model.collection`) are available with `chroma_` prefix, if you have similar methods defined in your model.
+All these methods (including `Model.query`, `Model.collection`, and `Model.delete_collection`) are available with `chroma_` prefix, if you have similar methods defined in your model.
 
 ## Development
 
@@ -89,7 +93,7 @@ To install this gem onto your local machine, run `bundle install`. To release a
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/AliOsm/chromable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/chromable/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/AliOsm/chromable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/AliOsm/chromable/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -97,4 +101,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Chromable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chromable/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Chromable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/AliOsm/chromable/blob/main/CODE_OF_CONDUCT.md).

data/lib/chromable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chromable
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/lib/chromable.rb

@@ -51,14 +51,7 @@ module Chromable
       Chroma::Resources::Collection.delete(chromable_settings.collection_name)
     end
 
-    def chroma_query( # rubocop:disable Metrics/ParameterLists
-      text:,
-      results: 10,
-      where: {},
-      where_document: {},
-      include: %w[metadatas documents distances],
-      **embedder_options
-    )
+    def chroma_query(text:, results: 10, where: {}, where_document: {}, **embedder_options)
       find(chroma_collection.query(
         query_embeddings: [send(chromable_settings.embedder, text, **embedder_options)],
         results: results,
@@ -77,6 +70,7 @@ module Chromable
         alias_method :embedding, :chroma_embedding unless method_defined? :embedding
         alias_method :upsert_embedding, :chroma_upsert_embedding unless method_defined? :upsert_embedding
         alias_method :destroy_embedding, :chroma_destroy_embedding unless method_defined? :destroy_embedding
+        alias_method :neighbors, :chroma_neighbors unless method_defined? :neighbors
         # rubocop:enable Style/Alias
       end
     end
@@ -93,6 +87,20 @@ module Chromable
       self.class.chroma_collection.delete(ids: [id])
     end
 
+    def chroma_neighbors(results: 10, where: {}, where_document: {})
+      collection = self.class.chroma_collection
+
+      embedding = collection.get(ids: [id], include: [:embeddings])[0].embedding
+
+      self.class.find(collection.query(
+        query_embeddings: [embedding],
+        results: results,
+        where: where,
+        where_document: where_document,
+        include: include
+      ).map(&:id))
+    end
+
     private
 
     def build_embedding

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chromable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ali Hamdi Ali Fadel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chroma-db