added to the integration test, dateRange query fixed in script, docs updated

Author: pferrel

README.md

@@ -262,7 +262,7 @@ The query returns personalized recommendations, similar items, or a mix includin
  },{
  “name”: “genre”,
  “values”: [“sci-fi”, “detective”]
- “bias”: 0.2 // boost/favor recommendations with the `genre’ = `sci-fi` or ‘detective’
+ “bias”: 1.02 // boost/favor recommendations with the `genre’ = `sci-fi` or ‘detective’
  }
  ]
 }
@@ -282,7 +282,7 @@ When the a date is stored in the items properties it can be used in a date range
  },{
  “name”: “genre”,
  “values”: [“sci-fi”, “detective”]
- “bias”: 0.2 // boost/favor recommendations with the `genre’ = `sci-fi` or ‘detective’
+ “bias”: 1.02 // boost/favor recommendations with the `genre’ = `sci-fi` or ‘detective’
  }
  ],
   "dateRange": {
@@ -308,8 +308,7 @@ When setting an available date and expire date on items, the current date can be
  },{
  “name”: “genre”,
  “values”: [“sci-fi”, “detective”]
- “bias”: 0.2 // boost/favor recommendations with the `genre’ = `sci-fi` or ‘detective’
- }
+ “bias”: 1.02 }
  ],
   "currentDate": "2015-08-15T11:28:45.114-07:00" 
 }
@@ -328,14 +327,22 @@ When setting an available date and expire date on items, the current date can be
  },{
  “name”: “genre”,
  “values”: [“sci-fi”, “detective”]
- “bias”: 0.2 // boost/favor recommendations with the `genre’ = `sci-fi` or ‘detective’
+ “bias”: 1.02 // boost/favor recommendations with the `genre’ = `sci-fi` or ‘detective’
  }
  ]
 }
 
 This returns items based on user xyz history or similar to item 53454543513 but favoring user history recommendations. These are filtered by categories and boosted to favor more genre specific items. 
 
-**Note**:This query should be considered **experimental**. mixing user history with item similarity is possible but may have unexpected results.
+**Note**:This query should be considered **experimental**. mixing user history with item similarity is possible but may have unexpected results. If you use this you should realize that user and item recommendations may be quite divergent and so mixing the them in query may produce nonsense. Use this only with the engine.json settings for "userbias" and "itembias" to favor one over the other.
+
+
+###Popular Items
+
+{
+}
+
+This is a simple way to get popular items. All returned scores will be 0 but the order will be based on relative popularity. Field-based biases for boosts and filters can also be applied.
 
 ##Events
 The Universal takes in potentially many events. These should be seen as a primary evnet, which is a very clear indication of a user preference and secondary events that we think may tell us something about user "taste" in some way. The Universal Recommender is built on a distributed Correlation Engine so it will test that these secondary events actually relate to the primary one and those that do not correlate will have little or no effect on recommendations (though they will make it longer to train and get query results). It is recommended that you start with one ot two events and increase the number as you see how these events effect results and timing.
@@ -402,6 +409,13 @@ To begin using new data with an engine that has been used with sample data or us
 
 ## Versions
 
+### v0.2.2
+
+ - a query with no item or user will get recommendations based on popularity
+ - a new integration test has been added
+ - a regression bug where some ids were being tokenized by Elasticsearch, leading to incorrect results, was fixed. **NOTE: for users with complex ids containing dashes or spaces this is an important fix.**
+ - a dateRange in the query now takes precidence to the item attached expiration and avaiable dates. 
+
 ### v0.2.1
 
  - date ranges attached to items will be compared to the prediction servers current data if no date is provided in the query. 

data/integration-test-expected.txt

@@ -83,3 +83,9 @@ Recommendations for no user no item, all from popularity, Tablets boost, Estados
 Recommendations for user: u1
 
 {"itemScores":[{"item":"Surface","score":0.049329958856105804}]}
+
+============ query with item and user *EXPERIMENTAL* ============
+
+Recommendations for no user no item, all from popularity, Tablets boost, Estados Unidos Mexicanos filter
+
+{"itemScores":[{"item":"Galaxy","score":1.3019405603408813},{"item":"Nexus","score":0.5091257691383362},{"item":"Surface","score":0.04033438116312027}]}

examples/integration-test

@@ -65,14 +65,13 @@ echo ""
 echo "Running test query."
 ./examples/multi-query-handmade.sh > test.out
 
+echo ""
+echo "Restoring engine.json"
+mv user-engine.json engine.json
 
 echo ""
 echo "Differences between expected and actual results, none is a passing test:"
 diff data/integration-test-expected.txt test.out
 
-echo ""
-echo "Restoring engine.json"
-mv user-engine.json engine.json
-
 echo ""
 echo "Note that the engine is still deployed until killed or this shell exists."

examples/multi-query-handmade.sh

@@ -202,3 +202,17 @@ curl -H "Content-Type: application/json" -d "
  }
 }" http://localhost:8000/queries.json
 echo ""
+
+echo ""
+echo "============ query with item and user *EXPERIMENTAL* ============"
+# This is experimental, use at your own risk, not well founded in theory
+echo ""
+echo "Recommendations for no user no item, all from popularity, Tablets boost, Estados Unidos Mexicanos filter"
+echo ""
+curl -H "Content-Type: application/json" -d '
+{
+ "user": "u1",
+ "item": "Iphone 4"
+}' http://localhost:8000/queries.json
+echo ""
+

examples/single-query-handmade.sh

@@ -1,21 +1,10 @@
 #!/usr/bin/env bash
 
-
-echo ""
-echo "============ dateRange filter ============"
-echo ""
-BEFORE=`date -v +1d +"%Y-%m-%dT%H:%M:%SZ"`
-AFTER=`date -v -1d +"%Y-%m-%dT%H:%M:%SZ"`
-#echo "before: $BEFORE after: $AFTER"
 echo "Recommendations for user: u1"
 echo ""
-curl -H "Content-Type: application/json" -d "
+curl -H "Content-Type: application/json" -d '
 {
- \"user\": \"u1\",
- \"dateRange\": {
- \"name\": \"date\",
- \"before\": \"$BEFORE\",
- \"after\": \"$AFTER\"
- }
-}" http://localhost:8000/queries.json
+ "user": "u1"
+}' http://localhost:8000/queries.json
 echo ""
+