Recombee API Client

A PHP client for easy use of the Recombee recommendation API.

If you don't have an account at Recombee yet, you can create a free account here.

Documentation of the API can be found at docs.recombee.com.

Installation

The best way to install the client is through dependency manager Composer:

composer require recombee/php-api-client

or

{
"require": {
"recombee/php-api-client": "^6.3.0"
}
}

Examples

Basic example

useRecombee\RecommApi\Client;
useRecombee\RecommApi\RequestsasReqs;
useRecombee\RecommApi\ExceptionsasEx;
$client = newClient('--my-database-id--', '--db-private-token--', ['region' => 'us-west']);
constNUM = 100;
constPROBABILITY_PURCHASED = 0.1;
try
{
// Generate some random purchases of items by users$purchase_requests = array();
for($i=0; $i < NUM; $i++) {
for($j=0; $j < NUM; $j++) {
if(mt_rand() / mt_getrandmax() < PROBABILITY_PURCHASED) {
$request = newReqs\AddPurchase("user-{$i}", "item-{$j}",
['cascadeCreate' => true] // Use cascadeCreate to create the// yet non-existing users and items
);
array_push($purchase_requests, $request);
}
}
}
echo"Send purchases\n";
$res = $client->send(newReqs\Batch($purchase_requests)); //Use Batch for faster processing of larger data// Get 5 recommendations for user 'user-25'$response = $client->send(newReqs\RecommendItemsToUser('user-25', 5));
echo'Recommended items: ' . json_encode($response, JSON_PRETTY_PRINT) . "\n";
// User scrolled down - get next 3 recommended items$response = $client->send(newReqs\RecommendNextItems($response['recommId'], 3));
echo'Next recommended items: ' . json_encode($response, JSON_PRETTY_PRINT) . "\n";
}
catch(Ex\ApiException$e)
{
//use fallback
}

Using property values

useRecombee\RecommApi\Client;
useRecombee\RecommApi\RequestsasReqs;
useRecombee\RecommApi\ExceptionsasEx;
constNUM = 100;
constPROBABILITY_PURCHASED = 0.1;
$client = newClient('--my-database-id--', '--db-private-token--', ['region' => 'ap-se']);
$client->send(newReqs\ResetDatabase()); // Clear everything from the database/*We will use computers as items in this exampleComputers have five properties  - price (floating point number) - number of processor cores (integer number) - description (string) - date from which it is in stock (timestamp) - image (url of computer's photo)*/// Add properties of items$client->send(newReqs\AddItemProperty('price', 'double'));
$client->send(newReqs\AddItemProperty('num-cores', 'int'));
$client->send(newReqs\AddItemProperty('description', 'string'));
$client->send(newReqs\AddItemProperty('in_stock_from', 'timestamp'));
$client->send(newReqs\AddItemProperty('image', 'image'));
# Prepare requests for setting a catalog of computers$requests = array();
for($i=0; $i<NUM; $i++)
{
$itemId = "computer-{$i}";
$r = newReqs\SetItemValues(
$itemId,
//values:
[ 'price' => rand(15000, 25000),
'num-cores' => rand(1, 8),
'description' => 'Great computer',
'in_stock_from' => newDateTime('NOW'),
'image' => "http://examplesite.com/products/{$itemId}.jpg"
],
//optional parameters:
['cascadeCreate' => true] // Use cascadeCreate for creating item// with given itemId, if it doesn't exist]
);
array_push($requests, $r);
}
// Send catalog to the recommender system$result = $client->send(newReqs\Batch($requests));
var_dump($result);
// Generate some random purchases of items by users$requests = array();
for($i=0; $i<NUM; $i++)
for($j=0; $j<NUM; $j++)
if(mt_rand() / mt_getrandmax() < PROBABILITY_PURCHASED)
{
$r = newReqs\AddPurchase("user-{$i}", "computer-{$j}", ['cascadeCreate' => true]);
array_push($requests, $r);
}
// Send purchases to the recommender system$client->send(newReqs\Batch($requests));
// Get 5 items related to item computer-6. Personalize them for user-42, who is currently viewing that item.// Recommend only computers that have at least 3 cores$recommended = $client->send(
newReqs\RecommendItemsToItem('computer-6', 'user-42', 5, ['filter' => "'num-cores'>=3"])
);
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(
newReqs\RecommendItemsToItem('computer-6', 'user-42', 5,
['filter' => "'price' > context_item[\"price\"]"])
);
echo'Recommended up-sell items: ' . json_encode($recommended, JSON_PRETTY_PRINT) . "\n";
// Filters, boosters and other settings can be set also in the Admin UI (admin.recombee.com)// when scenario is specified$recommended = $client->send(
newReqs\RecommendItemsToItem('computer-6', 'user-42', 5, ['scenario' => 'product_detail'])
);
// Perform personalized full-text search with a user's search query (e.g. 'computers')$matches = $client->send(
newReqs\SearchItems('user-42', 'computers', 5, ['scenario' => 'search_top'])
);
echo'Matched items: ' . json_encode($matches, JSON_PRETTY_PRINT) . "\n";

Exception handling

For the sake of brevity, the above examples omit exception handling. However, various exceptions can occur while processing request, for example because of adding an already existing item, submitting interaction of nonexistent user or because of timeout.

We are doing our best to provide the fastest and most reliable service, but production-level applications must implement a fallback solution since errors can always happen. The fallback might be, for example, showing the most popular items from the current category, or not displaying recommendations at all.

Example:

useRecombee\RecommApi\Client;
useRecombee\RecommApi\RequestsasReqs;
useRecombee\RecommApi\ExceptionsasEx;
try
{
$recommended = $client->send(
newReqs\RecommendItemsToItem('computer-6', 'user-42', 5,
['filter' => "'price' > context_item[\"price\"]"])
);
}
catch(Ex\ApiTimeoutException$e)
{
//Handle timeout => use fallback
}
catch(Ex\ResponseException$e)
{
//Handle errorneous request => use fallback
}
catch(Ex\ApiException$e)
{
//ApiException is parent of both ResponseException and ApiTimeoutException
}