Requests
Interfaces, Classes and Traits
- AddBookmark
- Adds a bookmark of a given item made by a given user.
- AddCartAddition
- Adds a cart addition of a given item made by a given user.
- AddDetailView
- Adds a detail view of a given item made by a given user.
- AddGroup
- Creates new group in the database.
- AddItem
- Adds new item of given `itemId` to the items catalog.
- AddItemProperty
- Adding an item property is somehow equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.
- AddPurchase
- Adds a purchase of a given item made by a given user.
- AddRating
- Adds a rating of given item made by a given user.
- AddSearchSynonym
- Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
- AddSeries
- Creates new series in the database.
- AddUser
- Adds a new user to the database.
- AddUserProperty
- Adding an user property is somehow equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
- Batch
- In many cases, it may be desirable to execute multiple requests at once. For example, when synchronizing the catalog of items in a periodical manner, you would have to execute a sequence of thousands of separate POST requests, which is very ineffective and may take a very long time to complete. Most notably, network latencies can make execution of such a sequence very slow and even if executed in multiple parallel threads, there will still be unreasonable overhead caused by the HTTP(s). To avoid the problems mentioned, batch processing may be used, encapsulating a sequence of requests into a single HTTP request.
- DeleteAllSearchSynonyms
- Deletes all synonyms defined in the database.
- DeleteBookmark
- Deletes a bookmark uniquely specified by `userId`, `itemId`, and `timestamp` or all the bookmarks with given `userId` and `itemId` if `timestamp` is omitted.
- DeleteCartAddition
- Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp` or all the cart additions with given `userId` and `itemId` if `timestamp` is omitted.
- DeleteDetailView
- Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`) or all the detail views with given `userId` and `itemId` if `timestamp` is omitted.
- DeleteGroup
- Deletes the group of given `groupId` from the database.
- DeleteItem
- Deletes an item of given `itemId` from the catalog.
- DeleteItemProperty
- Deleting an item property is roughly equivalent to removing a column from the table of items.
- DeleteMoreItems
- Delete all the items that pass the filter.
- DeletePurchase
- Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp` or all the purchases with given `userId` and `itemId` if `timestamp` is omitted.
- DeleteRating
- Deletes an existing rating specified by (`userId`, `itemId`, `timestamp`) from the database or all the ratings with given `userId` and `itemId` if `timestamp` is omitted.
- DeleteSearchSynonym
- Deletes synonym of given `id` and this synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
- DeleteSeries
- Deletes the series of given `seriesId` from the database.
- DeleteUser
- Deletes a user of given *userId* from the database.
- DeleteUserProperty
- Deleting an user property is roughly equivalent to removing a column from the table of users.
- DeleteViewPortion
- Deletes an existing view portion specified by (`userId`, `itemId`, `sessionId`) from the database.
- GetItemPropertyInfo
- Gets information about specified item property.
- GetItemValues
- Get all the current property values of a given item.
- GetUserPropertyInfo
- Gets information about specified user property.
- GetUserValues
- Get all the current property values of a given user.
- InsertToGroup
- Inserts an existing item/group into group of given `groupId`.
- InsertToSeries
- Inserts an existing item/series into series of given seriesId at position determined by time.
- ListGroupItems
- List all the items present in the given group.
- ListGroups
- Gets the list of all the groups currently present in the database.
- ListItemBookmarks
- List all the ever-made bookmarks of a given item.
- ListItemCartAdditions
- List all the ever-made cart addition of a given item.
- ListItemDetailViews
- List all the detail views of a given item ever made by different users.
- ListItemProperties
- Gets the list of all the item properties in your database.
- ListItemPurchases
- List all the ever-made purchases of a given item.
- ListItemRatings
- List all the ratings of an item ever submitted by different users.
- ListItems
- Gets a list of IDs of items currently present in the catalog.
- ListItemViewPortions
- List all the view portions of an item ever submitted by different users.
- ListSearchSynonyms
- Gives the list of synonyms defined in the database.
- ListSeries
- Gets the list of all the series currently present in the database.
- ListSeriesItems
- List all the items present in the given series, sorted according to their time index values.
- ListUserBookmarks
- List all the bookmarks ever made by a given user.
- ListUserCartAdditions
- List all the cart additions ever made by a given user.
- ListUserDetailViews
- Lists all the detail views of different items ever made by a given user.
- ListUserProperties
- Gets the list of all the user properties in your database.
- ListUserPurchases
- List all the purchases ever made by a given user.
- ListUserRatings
- List all the ratings ever submitted by a given user.
- ListUsers
- Gets a list of IDs of users currently present in the catalog.
- ListUserViewPortions
- List all the view portions ever submitted by a given user.
- MergeUsers
- Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
- RecommendItemsToItem
- 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.
- RecommendItemsToUser
- 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.
- RecommendNextItems
- Returns items that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (*infinite scroll*) or goes to a next page.
- RecommendUsersToItem
- Recommend users that are likely to be interested in a given item.
- RecommendUsersToUser
- Get similar users as some given user, based on the user's past interactions (purchases, ratings, etc.) and values of properties.
- RemoveFromGroup
- Removes an existing group item from the group.
- RemoveFromSeries
- Removes an existing series item from the series.
- Request
- Base class for all the requests
- ResetDatabase
- Completely erases all your data, including items, item properties, series, user database, purchases, ratings, detail views, and bookmarks. Make sure the request to be never executed in production environment! Resetting your database is irreversible.
- SearchItems
- Full-text personalized search. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.) with the items (items more suitable for the user are preferred in the results).
- SetItemValues
- Set/update (some) property values of a given item. The properties (columns) must be previously created by [Add item property](https://docs.recombee.com/api.html#add-item-property).
- SetUserValues
- Set/update (some) property values of a given user. The properties (columns) must be previously created by [Add user property](https://docs.recombee.com/api.html#add-user-property).
- SetValues
- Set/update (some) property values of an entity.
- SetViewPortion
- Sets viewed portion of an item (for example a video or article) by a user (at a session).
- UpdateMoreItems
- Update (some) property values of all the items that pass the filter.