jekyll_ai_related_posts 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b59977a0c1d912e06792f7123c7d443547f1decb9fdf4042d90a4fcd4e1eb4e
-  data.tar.gz: 159db1306777a201cff3a9d3532ddba444164dbfb780207fb9457ce4898df5f8
+  metadata.gz: 6b3f80af93fac9879714b6ee8806b101b1a2ede2337f285b19091888a9105718
+  data.tar.gz: 94d1b81c2c3ea6bde9628795e7ca24c1df5bf33108229d6a16cb72f336fcb676
 SHA512:
-  metadata.gz: e0f73857997bdacd22059c542a1d2a642a3ea76aa165241c155a0e8b2cafdc4f48607f334a2ed7a265a252e86969d9e523bf4ef2ac5889e1f39c36d1a27792f5
-  data.tar.gz: a5f5f573459deb7fab308b1fb98a1d60ce1aeda95e28860161ed886a3ab90c43f1b7d36fea6cc5c570b05cd15284a59240e8676f5b10f44290b05fbacbd379df
+  metadata.gz: 74cc6e541c458483e3891a3b10d0dc6f49266fec3e06312dceb733593c37c97c686e73f79e43d8c5d26e4edcf696c10f3695fc1d79e6941dceaf3983b9938f51
+  data.tar.gz: ab0d010676d87c601cdcb8237bc1b5275ecd2ca1dc39ae2648c83e4ae729c5acd6e3d5642d1a712ad5b5017dc8864e968b3d2a9e7308f97e45499155e7f44e41

data/README.md

@@ -1,5 +1,7 @@
 # Jekyll AI Related Posts 🪄
 
+Rubygems: [jekyll_ai_related_posts](https://rubygems.org/gems/jekyll_ai_related_posts)
+
 Jekyll ships with functionality that populates
 [related_posts](https://jekyllrb.com/docs/variables/) with the ten most recent
 posts. If you install
@@ -18,7 +20,12 @@ posts with the accuracy of OpenAI's models (or any other LLM, for that matter).
 
 Jekyll AI Related Posts is a [Jekyll
 plugin](https://jekyllrb.com/docs/plugins/installation/). It can be installed
-using any Jekyll plugin installation method.
+using any Jekyll plugin installation method. For example, in your `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll_ai_related_posts
+```
 
 ## Configuration
 
@@ -57,6 +64,20 @@ to use it:
 </ul>
 ```
 
+### First Run
+
+The first time the plugin runs, it will fetch embeddings for all your posts.
+Based on some light testing, this took me 0.5 sec per post, or about 50 sec for
+a blog with 100 posts. All subsequent runs will be faster since embeddings will
+be cached.
+
+### Cost
+
+The API costs to use this plugin with OpenAI's API are minimal. I ran this
+plugin for all 84 posts on [mikekasberg.com](https://www.mikekasberg.com) for
+$0.00 in API fees (1,277 tokens on the text-embedding-3-small model). (Your
+results may vary, but should remain inexpensive.)
+
 ### Upgrading from Built-In Related Posts
 
 If you're already using Jekyll's built-in `site.related_posts` and you want to
@@ -68,6 +89,17 @@ upgrade to AI related posts:
   option to the `jekyll` command. You can remove the `classifier-reborn` gem and
   its dependencies (Numo).
 
+### Cache File (.ai_related_posts_cache.sqlite3)
+
+This plugin will cache embeddings in `.ai_related_posts_cache.sqlite3` in your
+Jekyll source root (typically the root of your project directory). The file
+itself is a SQLite database file. For most cases, I'd recommend adding this file
+to your `.gitignore` since it's a binary cache file. However, you _may_ choose
+to check it in to git if, for example, you want to share cached embeddings
+across many machines (and are willing to check in a binary file on the order of
+1-10Mb to do so). If the file is not present, it will be re-created and
+embeddings will be fetched from the API (which may result in higher API usage
+fees if done frequently).
 
 ## How It Works
 
@@ -88,10 +120,9 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `rake spec` to run the tests. You can also run `bin/console` for an interactive
 prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and the created tag, and push the `.gem` file to
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and the created tag, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
 ## Contributing

data/lib/jekyll_ai_related_posts/generator.rb

@@ -12,6 +12,11 @@ module JekyllAiRelatedPosts
       @site = site
       setup_database
 
+      @indexed_posts = {}
+      site.posts.docs.each do |p|
+        @indexed_posts[p.relative_path] = p
+      end
+
       if fetch_enabled?
         Jekyll.logger.info "[ai_related_posts] Generating related posts..."
         @embeddings_fetcher = new_fetcher
@@ -20,11 +25,6 @@ module JekyllAiRelatedPosts
           ensure_embedding_cached(p)
         end
 
-        @indexed_posts = {}
-        site.posts.docs.each do |p|
-          @indexed_posts[p.relative_path] = p
-        end
-
         @site.posts.docs.each do |p|
           find_related(p)
         end

data/lib/jekyll_ai_related_posts/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllAiRelatedPosts
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_ai_related_posts
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mike Kasberg
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement