Personalized results - closes #4

Andrew Kane
1 parent e71c15f5
Showing 4 changed files with 46 additions and 2 deletions Show diff stats
README.md
lib/searchkick/search.rb
test/boost_test.rb
test/test_helper.rb
@@ -201,6 +201,29 @@ Reindex and set up a cron job to add new conversions daily.
 rake searchkick:reindex CLASS=Product
 ```
  
+### Personalized Results [master branch]
+
+**Subject to change before the next gem release**
+
+Order results differently for each user.  For example, show a user’s previously ordered products before other results.
+
+```ruby
+class Product < ActiveRecord::Base
+  def search_data
+    {
+      name: name,
+      user_ids: [4, 8, 15, 16, 23, 42] # boost this product for these users
+    }
+  end
+end
+```
+
+Reindex and search with:
+
+```ruby
+Product.search "milk", user_id: 8
+```
+
 ### Facets
  
 ```ruby
@@ -56,6 +56,13 @@ module Searchkick
                   script "log(doc['#{options[:boost]}'].value + 2.718281828)"
                 end
               end
+              if options[:user_id]
+                filter do
+                  filter :term, user_ids: options[:user_id]
+                  boost 100
+                end
+              end
+              score_mode "total"
             end
           end
           from options[:offset] if options[:offset]
@@ -46,4 +46,14 @@ class TestBoost &lt; Minitest::Unit::TestCase
     assert_order "product", ["Product Conversions", "Product Boost"], boost: "orders_count"
   end
  
+  def test_user_id
+    store [
+      {name: "Tomato A"},
+      {name: "Tomato B", user_ids: [1, 2, 3]},
+      {name: "Tomato C"},
+      {name: "Tomato D"}
+    ]
+    assert_first "tomato", "Tomato B", user_id: 2
+  end
+
 end
@@ -49,10 +49,10 @@ class Product &lt; ActiveRecord::Base
       ["bandaid", "bandag"]
     ]
  
-  attr_accessor :conversions
+  attr_accessor :conversions, :user_ids
  
   def search_data
-    as_json.merge conversions: conversions
+    as_json.merge conversions: conversions, user_ids: user_ids
   end
 end
  
@@ -89,4 +89,8 @@ class MiniTest::Unit::TestCase
     assert_equal expected, Product.search(term, options).map(&:name)
   end
  
+  def assert_first(term, expected, options = {})
+    assert_equal expected, Product.search(term, options).map(&:name).first
+  end
+
 end
...	...	@@ -201,6 +201,29 @@ Reindex and set up a cron job to add new conversions daily.
201	201	rake searchkick:reindex CLASS=Product
202	202	```
203	203
	204	+### Personalized Results [master branch]
	205	+
	206	+Subject to change before the next gem release
	207	+
	208	+Order results differently for each user. For example, show a user’s previously ordered products before other results.
	209	+
	210	+```ruby
	211	+class Product < ActiveRecord::Base
	212	+ def search_data
	213	+ {
	214	+ name: name,
	215	+ user_ids: [4, 8, 15, 16, 23, 42] # boost this product for these users
	216	+ }
	217	+ end
	218	+end
	219	+```
	220	+
	221	+Reindex and search with:
	222	+
	223	+```ruby
	224	+Product.search "milk", user_id: 8
	225	+```
	226	+
204	227	### Facets
205	228
206	229	```ruby
...	...
...	...	@@ -56,6 +56,13 @@ module Searchkick
56	56	script "log(doc['#{options[:boost]}'].value + 2.718281828)"
57	57	end
58	58	end
	59	+ if options[:user_id]
	60	+ filter do
	61	+ filter :term, user_ids: options[:user_id]
	62	+ boost 100
	63	+ end
	64	+ end
	65	+ score_mode "total"
59	66	end
60	67	end
61	68	from options[:offset] if options[:offset]
...	...
...	...	@@ -46,4 +46,14 @@ class TestBoost < Minitest::Unit::TestCase
46	46	assert_order "product", ["Product Conversions", "Product Boost"], boost: "orders_count"
47	47	end
48	48
	49	+ def test_user_id
	50	+ store [
	51	+ {name: "Tomato A"},
	52	+ {name: "Tomato B", user_ids: [1, 2, 3]},
	53	+ {name: "Tomato C"},
	54	+ {name: "Tomato D"}
	55	+ ]
	56	+ assert_first "tomato", "Tomato B", user_id: 2
	57	+ end
	58	+
49	59	end
...	...
...	...	@@ -49,10 +49,10 @@ class Product < ActiveRecord::Base
49	49	["bandaid", "bandag"]
50	50	]
51	51
52		- attr_accessor :conversions
	52	+ attr_accessor :conversions, :user_ids
53	53
54	54	def search_data
55		- as_json.merge conversions: conversions
	55	+ as_json.merge conversions: conversions, user_ids: user_ids
56	56	end
57	57	end
58	58
...	...	@@ -89,4 +89,8 @@ class MiniTest::Unit::TestCase
89	89	assert_equal expected, Product.search(term, options).map(&:name)
90	90	end
91	91
	92	+ def assert_first(term, expected, options = {})
	93	+ assert_equal expected, Product.search(term, options).map(&:name).first
	94	+ end
	95	+
92	96	end
...	...