chromable 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5695e34925255a187cf2cdca8337c8cb408e688b905984f28af08f43a12b8ffc
-  data.tar.gz: 5cbb179745647c0fd4fb982a4890570f6dbdf7e9d269f3af6b468949829cf83b
+  metadata.gz: a6d73bbad7320d850d166f26242c6dda3e66d953c8fce98ff6f7ccc442ba79be
+  data.tar.gz: 8d5c5bf8082c3736715f11c79d68d95781917e86c511e09a148293758d4bba4d
 SHA512:
-  metadata.gz: e281b9fd661de160e7c4c27a0333f7db04b57971a87cba74b8aaa4ff2eb1d5e12f4cb7683692b6ad26e8f048cb2e78ace7113e16f07c420fb3962e2259f3b8db
-  data.tar.gz: 73531acad9fecd1eea5da410e3191994bea0a7ff149da71f1f630b0c3770b8594af900c4efd86d64f0db02be2d8193d07d8c31f60790ae92233b578fc2595933
+  metadata.gz: c023701e1f6cf205af6d5fe8dfbf44f84904896c1cf8bb1937060d98f1f218c668524f02a75f60384ce109a26eb3c0a4a7394ab37c2a56c938dac33387572874
+  data.tar.gz: 5d75a9dc95ddefd0698d3544d9281a361ec16d89d49de3b93742f10f3a2798ac700da1c609a78bc2d6af31817ee798ffff8bfb28aa6d18b1793c871e07a84ef9

data/README.md

@@ -4,11 +4,19 @@ Ruby on Rails integration for ChromaDB based on `chroma-db` gem.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Since `chromable` is depending on `chroma-db` gem, you will need to install it using:
+
+    $ bundle add chroma-db
+
+Or, if you are not using bundler, install it by executing:
+
+    $ gem install chroma-db
+
+Then, install `chromable` and add to the application's Gemfile by executing:
 
     $ bundle add chromable
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or, if you are not using bundler, install it by executing:
 
     $ gem install chromable
 
@@ -24,19 +32,25 @@ Chroma.logger = Logger.new($stdout)
 Chroma.log_level = Chroma::LEVEL_ERROR
 ```
 
-Then, add the following line to your Rails model:
+Then, include `Chromable` module in your model and initialize it:
 
 ```ruby
-chromable document: :content, metadata: %i[author category], embedder: :embed
+class Post < ApplicationRecord
+  include Chromable
+
+  chromable document: :content, metadata: %i[author category], embedder: :embed
+end
 ```
 
 Where:
 - `document:` is a callable represents the text content you want to embed and store in ChromaDB.
-- `metadata:` is the list of attributes to be passed to ChromaDB as metadata.
-- `embedder:` is the method that returns the embedding representation for the current instance.
+- `metadata:` is the list of attributes to be passed to ChromaDB as metadata to be used to filter.
+- `embedder:` is a callable returns the embedding representation for the current instance.
 
 Optionaly you can pass `collection_name:`. If not passed, the plural form of the model name will be used.
 
+All `chromable` method arguments are optional.
+
 To interact with the ChromaDB collection, `chromable` provides `Model.collection` method to retrieve the collection instance.
 Also, `chromable` provides the following methods for each model instance:
 

data/lib/chromable/version.rb

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

data/lib/chromable.rb

@@ -19,7 +19,7 @@ module Chromable
   end
 
   class_methods do
-    def chromable(document:, metadata:, embedder:, collection_name: nil)
+    def chromable(collection_name: nil, document: nil, metadata: nil, embedder: nil)
       self.collection_name = (collection_name.presence || name.underscore.pluralize)
       self.document = document
       self.metadata = metadata
@@ -41,9 +41,9 @@ module Chromable
     self.class.chroma_collection.upsert(
       Chroma::Resources::Embedding.new(
         id: id,
-        document: send(self.class.document),
-        embedding: send(self.class.embedder),
-        metadata: self.class.metadata.index_with { |attribute| send(attribute) }
+        document: self.class.document ? send(self.class.document) : nil,
+        embedding: self.class.embedder ? send(self.class.embedder) : nil,
+        metadata: self.class.metadata ? self.class.metadata.index_with { |attribute| send(attribute) } : nil
       )
     )
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chromable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ali Hamdi Ali Fadel