Use new recommendation endpoints

Author: OndraFiedler

README.md

@@ -17,7 +17,7 @@ or
 ```
 {
     "require": {
-        "recombee/php-api-client": "^1.6.1"
+        "recombee/php-api-client": "^2.0.0"
     }
 }
 ```
@@ -30,7 +30,7 @@ use Recombee\RecommApi\Client;
 use Recombee\RecommApi\Requests as Reqs;
 use Recombee\RecommApi\Exceptions as Ex;
 
-$client = new Client('client-test', 'jGGQ6ZKa8rQ1zTAyxTc0EMn55YPF7FJLUtaMLhbsGxmvwxgTwXYqmUk5xVZFw98L');
+$client = new Client('--my-database-id--', '--my-secret-token--');
 
 const NUM = 100;
 const PROBABILITY_PURCHASED = 0.1;
@@ -55,9 +55,9 @@ try
     $res = $client->send(new Reqs\Batch($purchase_requests)); //Use Batch for faster processing of larger data
 
     // Get 5 recommendations for user 'user-25'
-    $recommended = $client->send(new Reqs\UserBasedRecommendation('user-25', 5));
+    $recommended = $client->send(new Reqs\RecommendItemsToUser('user-25', 5));
 
-    echo 'Recommended items: ' . implode(',',$recommended) . "\n";
+    echo 'Recommended items: ' . json_encode($recommended, JSON_PRETTY_PRINT) . "\n";
 }
 catch(Ex\ApiException $e)
 {
@@ -74,7 +74,7 @@ use Recombee\RecommApi\Exceptions as Ex;
 const NUM = 100;
 const PROBABILITY_PURCHASED = 0.1;
 
-$client = new Client('client-test', 'jGGQ6ZKa8rQ1zTAyxTc0EMn55YPF7FJLUtaMLhbsGxmvwxgTwXYqmUk5xVZFw98L');
+$client = new Client('--my-database-id--', '--my-secret-token--');
 $client->send(new Reqs\ResetDatabase()); //Clear everything from the database
 
 /*
@@ -130,21 +130,21 @@ for($i=0; $i<NUM; $i++)
 $client->send(new Reqs\Batch($requests));
 
 // Get 5 items related to item computer-6. Personalize them for user-42, who is currently viewing that item.
-$recommended = $client->send(new Reqs\ItemBasedRecommendation('computer-6', 5, ['targetUserId' => 'user-42']));
-echo 'Recommended items: ' . implode(',',$recommended) . "\n";
+$recommended = $client->send(new Reqs\RecommendItemsToItem('computer-6', 'user-42', 5));
+echo 'Recommended items: ' . json_encode($recommended, JSON_PRETTY_PRINT)  . "\n";
 
 // Recommend only computers that have at least 3 cores
 $recommended = $client->send(
-  new Reqs\ItemBasedRecommendation('computer-6', 5, ['targetUserId' => 'user-42', 'filter' => "'num-cores'>=3"])
+  new Reqs\RecommendItemsToItem('computer-6', 'user-42', 5, ['filter' => "'num-cores'>=3"])
   );
-echo 'Recommended items with at least 3 processor cores: ' . implode(',',$recommended) . "\n";
+echo 'Recommended items with at least 3 processor cores: ' . json_encode($recommended, JSON_PRETTY_PRINT) . "\n";
 
 // Recommend only items that are more expensive then currently viewed item computer-6 (up-sell)
 $recommended = $client->send(
-  new Reqs\ItemBasedRecommendation('computer-6', 5,
-    ['targetUserId' => 'user-42', 'filter' => "'price' > context_item[\"price\"]"])
+  new Reqs\RecommendItemsToItem('computer-6', 'user-42', 5,
+    ['filter' => "'price' > context_item[\"price\"]"])
   );
-echo 'Recommended up-sell items: ' . implode(',',$recommended) . "\n"
+echo 'Recommended up-sell items: ' . json_encode($recommended, JSON_PRETTY_PRINT) . "\n"
 ```
 
 ### Exception handling
@@ -162,8 +162,8 @@ use Recombee\RecommApi\Exceptions as Ex;
 try
 {
     $recommended = $client->send(
-      new Reqs\ItemBasedRecommendation('computer-6', 5,
-        ['targetUserId' => 'user-42', 'filter' => "'price' > context_item[\"price\"]"])
+      new Reqs\RecommendItemsToItem('computer-6', 'user-42', 5,
+        ['filter' => "'price' > context_item[\"price\"]"])
     );
 }
 catch(Ex\ApiTimeoutException $e)

src/RecommApi/Client.php

@@ -112,7 +112,7 @@ protected function getOptionalHttpHeaders() {
     }
 
     protected function getHttpHeaders() {
-        return array_merge(array('User-Agent' => 'recombee-php-api-client/1.6.1'), $this->getOptionalHttpHeaders()); 
+        return array_merge(array('User-Agent' => 'recombee-php-api-client/2.0.0'), $this->getOptionalHttpHeaders()); 
     }
 
     protected function getOptionalRequestOptions() {

src/RecommApi/Requests/ItemBasedRecommendation.php

@@ -12,6 +12,7 @@
 /**
  * Recommends set of items that are somehow related to one given item, *X*. Typical scenario for using item-based recommendation is when user *A* is viewing *X*. Then you may display items to the user that he might be also interested in. Item-recommendation request gives you Top-N such items, optionally taking the target user *A* into account.
  *  It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+ * @deprecated 2.0.0 Use RecommendItemsToItem request instead.
  */
 class ItemBasedRecommendation extends Request {
 

src/RecommApi/Requests/RecommendItemsToItem.php

@@ -10,7 +10,6 @@
 use Recombee\RecommApi\Exceptions\UnknownOptionalParameterException;
 
 /**
- * This feature is currently in beta.
  * Recommends set of items that are somehow related to one given item, *X*. Typical scenario  is when user *A* is viewing *X*. Then you may display items to the user that he might be also interested in. Recommend items to item request gives you Top-N such items, optionally taking the target user *A* into account.
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  */
@@ -31,8 +30,8 @@ class RecommendItemsToItem extends Request {
      * If you insist on not specifying the user, pass `null`
      * (`None`, `nil`, `NULL` etc. depending on language) to *targetUserId*.
      * Do not create some special dummy user for getting recommendations,
-     * as it could cause  mislead the recommendation models,
-     * leading to wrong recommendations.
+     * as it could mislead the recommendation models,
+     * and result in wrong recommendations.
      * For anonymous/unregistered users it is possible to use for example their session ID.
      */
     protected $target_user_id;
@@ -156,8 +155,8 @@ class RecommendItemsToItem extends Request {
      * If you insist on not specifying the user, pass `null`
      * (`None`, `nil`, `NULL` etc. depending on language) to *targetUserId*.
      * Do not create some special dummy user for getting recommendations,
-     * as it could cause  mislead the recommendation models,
-     * leading to wrong recommendations.
+     * as it could mislead the recommendation models,
+     * and result in wrong recommendations.
      * For anonymous/unregistered users it is possible to use for example their session ID.
      * @param int $count Number of items to be recommended (N for the top-N recommendation).
      * @param array $optional Optional parameters given as an array containing pairs name of the parameter => value

src/RecommApi/Requests/RecommendItemsToUser.php

@@ -10,7 +10,6 @@
 use Recombee\RecommApi\Exceptions\UnknownOptionalParameterException;
 
 /**
- * This feature is currently in beta.
  * Based on user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for a given user.
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  */

src/RecommApi/Requests/RecommendUsersToItem.php

@@ -10,7 +10,6 @@
 use Recombee\RecommApi\Exceptions\UnknownOptionalParameterException;
 
 /**
- * This feature is currently in beta.
  * Recommend users that are likely to be interested in a given item.
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  */

src/RecommApi/Requests/RecommendUsersToUser.php

@@ -10,7 +10,6 @@
 use Recombee\RecommApi\Exceptions\UnknownOptionalParameterException;
 
 /**
- * This feature is currently in beta.
  * Get similar users as some given user, based on the user's past interactions (purchases, ratings, etc.) and values of properties.
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  */

src/RecommApi/Requests/UserBasedRecommendation.php

@@ -12,6 +12,7 @@
 /**
  * Based on user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for a given user.
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+ * @deprecated 2.0.0 Use RecommendItemsToUser request instead.
  */
 class UserBasedRecommendation extends Request {