jekyll_ai_related_posts 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b3f80af93fac9879714b6ee8806b101b1a2ede2337f285b19091888a9105718
-  data.tar.gz: 94d1b81c2c3ea6bde9628795e7ca24c1df5bf33108229d6a16cb72f336fcb676
+  metadata.gz: bd10032e0e9758acac7f0dc26d79aaa2a8de36e8872be41ecd62f915b4422847
+  data.tar.gz: f999747d95b4b9dce7c1fd6fcad198959a1734c13dfc50cbdd57bdb267f0fcdc
 SHA512:
-  metadata.gz: 74cc6e541c458483e3891a3b10d0dc6f49266fec3e06312dceb733593c37c97c686e73f79e43d8c5d26e4edcf696c10f3695fc1d79e6941dceaf3983b9938f51
-  data.tar.gz: ab0d010676d87c601cdcb8237bc1b5275ecd2ca1dc39ae2648c83e4ae729c5acd6e3d5642d1a712ad5b5017dc8864e968b3d2a9e7308f97e45499155e7f44e41
+  metadata.gz: ea9b61e8f8e3b9148146eece6a453abc57e720c295db1b99d11d6ef6786c206a4efdca194c6c0d8287133699517775b242aa9b4cae5af1cc10ee40903be3c0ab
+  data.tar.gz: 9d43069c05704e7c032840e4fc6409da6fd2ca437b5b2cf282021a84b0c64fa9b1761c03ab3694759261cf10b26cd087a49ace883f1d4c85e5f365d90d0b8bb2

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-04-18
+## [0.1.2] - 2024-04-24
+
+- [Bugfix] Include up to 10 related posts (like native Jekyll does) instead of just 3.
+
+## [0.1.1] - 2024-04-23
+
+- [Bugfix] Exception when running in cache-only mode.
+
+## [0.1.0] - 2024-04-23
 
 - Initial release

data/README.md

@@ -16,6 +16,13 @@ embeddings API that allows us to easily get the embedding vector (in one of
 OpenAI's models) of some text. We can use these vectors to compute related
 posts with the accuracy of OpenAI's models (or any other LLM, for that matter).
 
+### Used in Production at
+
+- [MikeKasberg.com](https://www.mikekasberg.com)
+
+(Feel free to open a PR to add your website if you're using this gem in
+production!)
+
 ## Installation
 
 Jekyll AI Related Posts is a [Jekyll
@@ -27,6 +34,16 @@ plugins:
   - jekyll_ai_related_posts
 ```
 
+You should also ignore the cache files that this plugin generates. (This will
+help avoid a regeneration loop when using `jekyll serve`.)
+
+```yaml
+exclude:
+  - .ai_related_posts_cache.sqlite3
+  - .ai_related_posts_cache.sqlite3-journal
+```
+
+
 ## Configuration
 
 All config for this plugin sits under a top-level `ai_related_posts` key.
@@ -71,6 +88,13 @@ 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.
 
+### Performance
+
+On an example blog with ~100 posts, this plugin produces more accurate results
+than classifier-reborn (LSI) in about the same amount of time. See [this blog
+post](https://www.mikekasberg.com/blog/2024/04/23/better-related-posts-in-jekyll-using-ai.html)
+for details.
+
 ### Cost
 
 The API costs to use this plugin with OpenAI's API are minimal. I ran this

data/gemfiles/current.gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll_ai_related_posts.gemspec
+gemspec path: '../'
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-rails-omakase", require: false
+
+gem "debug"

data/gemfiles/jekyll3.gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "jekyll", "~> 3.9"
+gem "kramdown-parser-gfm"
+
+# Specify your gem's dependencies in jekyll_ai_related_posts.gemspec
+gemspec path: '../'
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-rails-omakase", require: false
+
+gem "debug"

data/lib/jekyll_ai_related_posts/generator.rb

@@ -9,6 +9,8 @@ require "json"
 module JekyllAiRelatedPosts
   class Generator < Jekyll::Generator
     def generate(site)
+      Jekyll.logger.info "AI Related Posts:", "Generating related posts..."
+
       @site = site
       setup_database
 
@@ -18,7 +20,6 @@ module JekyllAiRelatedPosts
       end
 
       if fetch_enabled?
-        Jekyll.logger.info "[ai_related_posts] Generating related posts..."
         @embeddings_fetcher = new_fetcher
 
         @site.posts.docs.each do |p|
@@ -29,7 +30,7 @@ module JekyllAiRelatedPosts
           find_related(p)
         end
       else
-        Jekyll.logger.info "[ai_related_posts] Using cached related posts data..."
+        Jekyll.logger.info "AI Related Posts:", "Fetch disabled. Using cached related posts data."
 
         @site.posts.docs.each do |p|
           fallback_generate_related(p)
@@ -111,7 +112,7 @@ module JekyllAiRelatedPosts
                                                                                         relative_path: post.relative_path
                                                                                       } ]))
       # The first result is the post itself, with a distance of 0.
-      rowids = results.sort_by { |r| r["distance"] }.drop(1).first(3).map { |r| r["rowid"] }
+      rowids = results.sort_by { |r| r["distance"] }.drop(1).first(10).map { |r| r["rowid"] }
 
       posts_by_rowid = {}
       rowids.each do |rowid|
@@ -139,7 +140,7 @@ module JekyllAiRelatedPosts
     end
 
     def embedding_for(post)
-      Jekyll.logger.info "[ai_related_posts] Fetching embedding for #{post.relative_path}"
+      Jekyll.logger.info "AI Related Posts:", "Fetching embedding for #{post.relative_path}"
       input = embedding_text(post)
 
       @embeddings_fetcher.embedding_for(input)
@@ -175,7 +176,7 @@ module JekyllAiRelatedPosts
       SQL
       ActiveRecord::Base.connection.execute(create_vss_posts)
 
-      Jekyll.logger.debug("ai_related_posts db setup complete")
+      Jekyll.logger.debug "AI Related Posts:", "DB setup complete"
     end
   end
 end

data/lib/jekyll_ai_related_posts/open_ai_embeddings.rb

@@ -29,8 +29,8 @@ module JekyllAiRelatedPosts
 
       res.body["data"].first["embedding"]
     rescue Faraday::Error => e
-      Jekyll.logger.error "Error response from OpanAI API!"
-      Jekyll.logger.error e.inspect
+      Jekyll.logger.error "AI Related Posts:", "Error response from OpenAI API!"
+      Jekyll.logger.error "AI Related Posts:", e.inspect
 
       raise
     end

data/lib/jekyll_ai_related_posts/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_ai_related_posts
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Mike Kasberg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -107,6 +107,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/current.gemfile
+- gemfiles/jekyll3.gemfile
 - lib/jekyll_ai_related_posts.rb
 - lib/jekyll_ai_related_posts/generator.rb
 - lib/jekyll_ai_related_posts/models/post.rb
@@ -119,7 +121,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/mkasberg/jekyll_ai_related_posts
   source_code_uri: https://github.com/mkasberg/jekyll_ai_related_posts
-  changelog_uri: https://github.com/mkasberg/jekyll_ai_related_posts
+  changelog_uri: https://github.com/mkasberg/jekyll_ai_related_posts/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: