Skip to content

Latest commit

 

History

History
79 lines (64 loc) · 2.32 KB

UPGRADE-4.0.md

File metadata and controls

79 lines (64 loc) · 2.32 KB
Raw

Upgrading from 3.x to 4.0

API client release 4.0 contains backward incompatible changes.

This guide will help you upgrade your codebase.

Sorting renamed to ItemSorting

Class Sorting was renamed to ItemSorting. All its methods and behavior remained the same.

Before

$response =  $matej->request()
    ->sorting(Sorting::create('user-id', ['item-id-1', 'item-id-2', 'item-id-3']))
    ->send();

After

$response =  $matej->request()
    ->sorting(ItemSorting::create('user-id', ['item-id-1', 'item-id-2', 'item-id-3']))
    ->send();

New types of recommendations

API client now supports new types of recommendation commands:

  • Recommend items to user (UserItemRecommendation, originally UserRecommendation)
  • Recommend users to user (UserUserRecommendation)
  • Recommend items to item (ItemItemRecommendation)
  • Recommend users to item (ItemUserRecommendation)

Each recommendation type supports different parameter options. Available parameters are documented in readme.

Recommending items to users

Class UserRecommendation was renamed to UserItemRecommendation. Class MinimalRelevance was renamed to ItemMinimalRelevance. All other methods and attributes remained unchanged.

Before

$recommendation = UserRecommendation::create('user-id', 'scenario')
    ->setMinimalRelevance(MinimalRelevance::LOW())
    ->setCount(5)
    ->setRotationRate(1.0)
    ->setRotationTime(3600);

After

$recommendation = UserItemRecommendation::create('user-id', 'scenario')
    ->setMinimalRelevance(ItemMinimalRelevance::LOW())
    ->setCount(5)
    ->setRotationRate(1.0)
    ->setRotationTime(3600);

New recommendation types

New types of recommendations can be created in a similar way to UserItemRecommendation. For example:

Users that might be interested in an item

$recommendation = ItemUserRecommendation::create('item-id', 'scenario')
    ->setCount(5)
    ->setAllowSeen(false);

Users that are similar to a user

$recommendation = UserUserRecommendation::create('user-id', 'scenario')
    ->setCount(5)
    ->setRotationRate(1.0)
    ->setRotationTime(3600);

Items that are similar to an item

$recommendation = ItemItemRecommendation::create('item-id', 'scenario')
    ->setCount(5);