public class SugestioClient
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
SugestioClient.PartitionType |
static class |
SugestioClient.ResourceType |
static class |
SugestioClient.Verb |
Constructor and Description |
---|
SugestioClient(java.lang.String account,
java.lang.String secret)
Creates a new instance of the SugestioClient with the given access credentials.
|
SugestioClient(java.lang.String account,
java.lang.String secret,
int bulkMaxCount,
int bulkThreads)
Creates a new instance of the SugestioClient with the given access credentials and concurrency options.
|
SugestioClient(SugestioConfig config)
Creates a new instance of the SugestioClient with the given Config object.
|
Modifier and Type | Method and Description |
---|---|
SugestioResult<java.lang.String> |
addConsumption(Consumption consumption)
Submit a single consumption
|
java.util.Map<java.util.List<Consumption>,SugestioResult<java.lang.String>> |
addConsumptions(java.util.List<Consumption> consumptions)
Efficient method for adding multiple consumptions.
|
SugestioResult<java.lang.String> |
addItem(Item item)
Add or update a single item.
|
java.util.Map<java.util.List<Item>,SugestioResult<java.lang.String>> |
addItems(java.util.List<Item> items)
Efficient method for adding multiple items
|
SugestioResult<java.lang.String> |
addUser(User user)
Add or update a single user.
|
java.util.Map<java.util.List<User>,SugestioResult<java.lang.String>> |
addUsers(java.util.List<User> users)
Efficient method for adding multiple users
|
SugestioResult<java.lang.String> |
deleteConsumption(java.lang.String consumptionId)
Deletes the consumption identified by the given consumptionId.
|
java.util.Map<java.lang.String,SugestioResult<java.lang.String>> |
deleteConsumptions(java.util.List<java.lang.String> consumptionIds)
Deletes the consumptions identified by the given consumptionIds.
|
SugestioResult<java.lang.String> |
deleteItem(java.lang.String itemId)
Deletes the metadata of the given user.
|
SugestioResult<java.lang.String> |
deleteRecommendation(java.lang.String userId,
java.lang.String itemId)
Indicate that the user did not appreciate a certain recommendation.
|
SugestioResult<java.lang.String> |
deleteUser(java.lang.String userId)
Deletes the metadata of the given user.
|
SugestioResult<java.lang.String> |
deleteUserConsumptions(java.lang.String userId,
java.lang.String itemId)
Deletes the consumption data of the given user, optionally filtered by itemId.
|
java.util.List<Report> |
getAnalytics(java.lang.Integer limit)
Get analytics data.
|
Consumption |
getConsumption(java.lang.String consumptionId)
Retrieves the consumption with given consumptionId
|
java.util.List<Consumption> |
getConsumptionHistory(java.lang.String userId,
java.lang.String itemId)
Retrieve the consumptions this user has made, optionally filtered by itemId.
|
Item |
getItem(java.lang.String itemId)
Retrieves the item metadata for the given itemId.
|
java.util.Map<java.lang.String,SugestioResult<java.util.List<Recommendation>>> |
getRecommendations(java.util.List<java.lang.String> userIds)
Gets recommendations for the given userIds
|
java.util.Map<java.lang.String,SugestioResult<java.util.List<Recommendation>>> |
getRecommendations(java.util.List<java.lang.String> userIds,
SugestioClient.PartitionType partitionType,
java.lang.String partitionId)
Gets recommendations for the given userIds, limited to the given partition
|
java.util.List<Recommendation> |
getRecommendations(java.lang.String userId)
Gets recommendations for the given userId
|
java.util.List<Recommendation> |
getRecommendations(java.lang.String userId,
RecommendationFilter filter)
Gets recommendations for the given userId
|
java.util.List<Recommendation> |
getRecommendations(java.lang.String userId,
SugestioClient.PartitionType partitionType,
java.lang.String partitionId)
Gets recommendations for the given userId, limited to the given partition
|
java.util.Map<java.lang.String,SugestioResult<java.util.List<Recommendation>>> |
getSimilar(java.util.List<java.lang.String> itemIds)
Gets similar items for the given itemIds
|
java.util.Map<java.lang.String,SugestioResult<java.util.List<Recommendation>>> |
getSimilar(java.util.List<java.lang.String> itemIds,
SugestioClient.PartitionType partitionType,
java.lang.String partitionId)
Gets similar items for the given itemIds, limited to the given partition
|
java.util.List<Recommendation> |
getSimilar(java.lang.String itemId)
Gets items that are similar to the given item
|
java.util.List<Recommendation> |
getSimilar(java.lang.String itemId,
RecommendationFilter filter)
Gets items that are similar to the given item
|
java.util.List<Recommendation> |
getSimilar(java.lang.String itemId,
SugestioClient.PartitionType partitionType,
java.lang.String partitionId)
Gets items that are similar to the given item, limited to the given partition
|
void |
shutdown()
Initiates an orderly shutdown of the client.
|
public SugestioClient(java.lang.String account, java.lang.String secret)
account
- your account keysecret
- your secret keypublic SugestioClient(java.lang.String account, java.lang.String secret, int bulkMaxCount, int bulkThreads)
account
- your account keysecret
- your secret keybulkMaxCount
- number of users, items or consumptions to submit in a single requestbulkThreads
- number of concurrent requestpublic SugestioClient(SugestioConfig config)
config
- public void shutdown()
java.lang.Exception
public java.util.List<Recommendation> getRecommendations(java.lang.String userId) throws SugestioException
userId
- id of the userSugestioException
public java.util.List<Recommendation> getRecommendations(java.lang.String userId, RecommendationFilter filter) throws SugestioException
userId
- id of the userfilter
- recommendation filterSugestioException
public java.util.List<Recommendation> getRecommendations(java.lang.String userId, SugestioClient.PartitionType partitionType, java.lang.String partitionId) throws SugestioException
userId
- id of the userpartitionType
- limit recommendations to one category, one product segment, ...partitionId
- id of the category or segmentSugestioException
public java.util.Map<java.lang.String,SugestioResult<java.util.List<Recommendation>>> getRecommendations(java.util.List<java.lang.String> userIds)
userIds
- a list of userIdspublic java.util.Map<java.lang.String,SugestioResult<java.util.List<Recommendation>>> getRecommendations(java.util.List<java.lang.String> userIds, SugestioClient.PartitionType partitionType, java.lang.String partitionId)
userIds
- a list of userIdspartitionType
- limit recommendations to one category, one segment, ...partitionId
- id of the category or segmentpublic java.util.List<Recommendation> getSimilar(java.lang.String itemId) throws SugestioException
itemId
- id of the itemSugestioException
public java.util.List<Recommendation> getSimilar(java.lang.String itemId, RecommendationFilter filter) throws SugestioException
itemId
- id of the itemfilter
- recommendation filterSugestioException
public java.util.List<Recommendation> getSimilar(java.lang.String itemId, SugestioClient.PartitionType partitionType, java.lang.String partitionId) throws SugestioException
itemId
- id of the itempartitionType
- limit items to one category, one segment, ...partitionId
- id of the category or segmentSugestioException
public java.util.Map<java.lang.String,SugestioResult<java.util.List<Recommendation>>> getSimilar(java.util.List<java.lang.String> itemIds) throws SugestioException
itemIds
- list of item idsSugestioException
public java.util.Map<java.lang.String,SugestioResult<java.util.List<Recommendation>>> getSimilar(java.util.List<java.lang.String> itemIds, SugestioClient.PartitionType partitionType, java.lang.String partitionId) throws SugestioException
itemIds
- the items for which to get similar itemspartitionType
- limit items to one category, one segment, ...partitionId
- id of the category or segmentSugestioException
public SugestioResult<java.lang.String> deleteRecommendation(java.lang.String userId, java.lang.String itemId) throws SugestioException
userId
- userIditemId
- itemIdSugestioException
public Consumption getConsumption(java.lang.String consumptionId) throws SugestioException
consumptionId
- SugestioException
public java.util.List<Consumption> getConsumptionHistory(java.lang.String userId, java.lang.String itemId) throws SugestioException
userId
- userId (required)itemId
- itemId (optional)SugestioException
public SugestioResult<java.lang.String> addConsumption(Consumption consumption) throws SugestioException
consumption
- SugestioException
public java.util.Map<java.util.List<Consumption>,SugestioResult<java.lang.String>> addConsumptions(java.util.List<Consumption> consumptions)
consumptions
- list of consumptionspublic SugestioResult<java.lang.String> deleteUserConsumptions(java.lang.String userId, java.lang.String itemId) throws SugestioException
userId
- (required)itemId
- (optional) the item consumptions to deleteSugestioException
public SugestioResult<java.lang.String> deleteConsumption(java.lang.String consumptionId) throws SugestioException
consumptionId
- SugestioException
public java.util.Map<java.lang.String,SugestioResult<java.lang.String>> deleteConsumptions(java.util.List<java.lang.String> consumptionIds) throws SugestioException
consumptionIds
- SugestioException
public SugestioResult<java.lang.String> addUser(User user) throws SugestioException
user
- SugestioException
public java.util.Map<java.util.List<User>,SugestioResult<java.lang.String>> addUsers(java.util.List<User> users)
users
- list of userspublic SugestioResult<java.lang.String> deleteUser(java.lang.String userId) throws SugestioException
userId
- SugestioException
public Item getItem(java.lang.String itemId) throws SugestioException
itemId
- SugestioException
public SugestioResult<java.lang.String> addItem(Item item) throws SugestioException
item
- SugestioException
public java.util.Map<java.util.List<Item>,SugestioResult<java.lang.String>> addItems(java.util.List<Item> items)
items
- list of itemspublic SugestioResult<java.lang.String> deleteItem(java.lang.String itemId) throws SugestioException
itemId
- SugestioException
public java.util.List<Report> getAnalytics(java.lang.Integer limit) throws SugestioException
limit
- number of reportsSugestioException