Package com.algolia.search

Class PersonalizationClient

java.lang.Object

com.algolia.search.PersonalizationClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class PersonalizationClient
extends Object
implements Closeable

Algolia's REST recommendation client that wraps an instance of the transporter HttpTransport which wraps the HTTP Client This client allows to build typed requests and read typed responses. Requests are made under the Algolia's retry-strategy. This client is intended to be reused and it's thread-safe.

See Also:

Algolia.com

Constructor Summary

Constructors

Constructor	Description
PersonalizationClient(PersonalizationConfig config, HttpRequester httpRequester)	Creates a custom PersonalizationClient with the given PersonalizationConfig and the given HttpRequester

Method Summary

Modifier and Type	Method	Description
void	close()	Close the underlying Http Client
DeletePersonalizationProfileResponse	deletePersonalizationProfile(String userToken)	Delete the user profile and all its associated data.
DeletePersonalizationProfileResponse	deletePersonalizationProfile(String userToken, RequestOptions requestOptions)	Delete the user profile and all its associated data.
CompletableFuture<DeletePersonalizationProfileResponse>	deletePersonalizationProfileAsync(String userToken)	Delete the user profile and all its associated data.
CompletableFuture<DeletePersonalizationProfileResponse>	deletePersonalizationProfileAsync(String userToken, RequestOptions requestOptions)	Delete the user profile and all its associated data.
ConfigBase	getConfig()	Get Client's configuration
PersonalizationProfileResponse	getPersonalizationProfile(String userToken)	Get the user profile built from Personalization strategy.
PersonalizationProfileResponse	getPersonalizationProfile(String userToken, RequestOptions requestOptions)	Get the user profile built from Personalization strategy.
CompletableFuture<PersonalizationProfileResponse>	getPersonalizationProfileAsync(String userToken)	Get the user profile built from Personalization strategy.
CompletableFuture<PersonalizationProfileResponse>	getPersonalizationProfileAsync(String userToken, RequestOptions requestOptions)	Get the user profile built from Personalization strategy.
GetStrategyResponse	getPersonalizationStrategy()	Returns the personalization strategy of the application
GetStrategyResponse	getPersonalizationStrategy(RequestOptions requestOptions)	Returns the personalization strategy of the application
CompletableFuture<GetStrategyResponse>	getPersonalizationStrategyAsync()	Returns the personalization strategy of the application
CompletableFuture<GetStrategyResponse>	getPersonalizationStrategyAsync(RequestOptions requestOptions)	Returns the personalization strategy of the application
HttpTransport	getTransport()	Transport object responsible for the serialization/deserialization and the retry strategy.
SetStrategyResponse	setPersonalizationStrategy(SetStrategyRequest request)	This command configures the personalization strategy
SetStrategyResponse	setPersonalizationStrategy(SetStrategyRequest request, RequestOptions requestOptions)	This command configures the personalization strategy
CompletableFuture<SetStrategyResponse>	setPersonalizationStrategyAsync(SetStrategyRequest request)	This command configures the personalization strategy
CompletableFuture<SetStrategyResponse>	setPersonalizationStrategyAsync(SetStrategyRequest request, RequestOptions requestOptions)	This command configures the personalization strategy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PersonalizationClient

public PersonalizationClient(@Nonnull
                             PersonalizationConfig config,
                             @Nonnull
                             HttpRequester httpRequester)

Creates a custom PersonalizationClient with the given PersonalizationConfig and the given HttpRequester

Parameters:

config - The configuration allows you to advanced configuration of the clients such as batch size or custom hosts and timeout.

httpRequester - Another HTTP Client than the default one. Must be an implementation of HttpRequester.

Throws:

NullPointerException - If one of the following ApplicationID/ApiKey/Configuration/Requester is null

IllegalArgumentException - If the ApplicationID or the APIKey are empty

Method Detail

close

public void close()
           throws IOException

Close the underlying Http Client

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an I/O error occurs

getTransport

public HttpTransport getTransport()

Transport object responsible for the serialization/deserialization and the retry strategy.

getPersonalizationStrategy

public GetStrategyResponse getPersonalizationStrategy()

Returns the personalization strategy of the application

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getPersonalizationStrategy

public GetStrategyResponse getPersonalizationStrategy(RequestOptions requestOptions)

Returns the personalization strategy of the application

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getPersonalizationStrategyAsync

public CompletableFuture<GetStrategyResponse> getPersonalizationStrategyAsync()

Returns the personalization strategy of the application

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getPersonalizationStrategyAsync

public CompletableFuture<GetStrategyResponse> getPersonalizationStrategyAsync(RequestOptions requestOptions)

Returns the personalization strategy of the application

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setPersonalizationStrategy

public SetStrategyResponse setPersonalizationStrategy(@Nonnull
                                                      SetStrategyRequest request)

This command configures the personalization strategy

Parameters:

request - The personalization strategy

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setPersonalizationStrategy

public SetStrategyResponse setPersonalizationStrategy(@Nonnull
                                                      SetStrategyRequest request,
                                                      RequestOptions requestOptions)

This command configures the personalization strategy

Parameters:

request - The personalization strategy

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setPersonalizationStrategyAsync

public CompletableFuture<SetStrategyResponse> setPersonalizationStrategyAsync(@Nonnull
                                                                              SetStrategyRequest request)

This command configures the personalization strategy

Parameters:

request - The personalization strategy

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setPersonalizationStrategyAsync

public CompletableFuture<SetStrategyResponse> setPersonalizationStrategyAsync(@Nonnull
                                                                              SetStrategyRequest request,
                                                                              RequestOptions requestOptions)

This command configures the personalization strategy

Parameters:

request - The personalization strategy

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getPersonalizationProfile

public PersonalizationProfileResponse getPersonalizationProfile(@Nonnull
                                                                String userToken)

Get the user profile built from Personalization strategy.

The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getPersonalizationProfile

public PersonalizationProfileResponse getPersonalizationProfile(@Nonnull
                                                                String userToken,
                                                                RequestOptions requestOptions)

Get the user profile built from Personalization strategy.

The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getPersonalizationProfileAsync

public CompletableFuture<PersonalizationProfileResponse> getPersonalizationProfileAsync(@Nonnull
                                                                                        String userToken)

Get the user profile built from Personalization strategy.

The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getPersonalizationProfileAsync

public CompletableFuture<PersonalizationProfileResponse> getPersonalizationProfileAsync(@Nonnull
                                                                                        String userToken,
                                                                                        RequestOptions requestOptions)

Get the user profile built from Personalization strategy.

The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.

Parameters:

userToken - userToken representing the user for which to fetch the Personalization profile

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deletePersonalizationProfile

public DeletePersonalizationProfileResponse deletePersonalizationProfile(@Nonnull
                                                                         String userToken)

Delete the user profile and all its associated data.

Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means that if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.

It might take a couple hours before for the deletion request to be fully processed.

Parameters:

userToken - userToken representing the user for which to delete the Personalization profile and associated data.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deletePersonalizationProfile

public DeletePersonalizationProfileResponse deletePersonalizationProfile(@Nonnull
                                                                         String userToken,
                                                                         RequestOptions requestOptions)

Delete the user profile and all its associated data.

Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means that if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.

It might take a couple hours before for the deletion request to be fully processed.

Parameters:

userToken - userToken representing the user for which to delete the Personalization profile and associated data.

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deletePersonalizationProfileAsync

public CompletableFuture<DeletePersonalizationProfileResponse> deletePersonalizationProfileAsync(@Nonnull
                                                                                                 String userToken)

Delete the user profile and all its associated data.

Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means that if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.

It might take a couple hours before for the deletion request to be fully processed.

Parameters:

userToken - userToken representing the user for which to delete the Personalization profile and associated data.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deletePersonalizationProfileAsync

public CompletableFuture<DeletePersonalizationProfileResponse> deletePersonalizationProfileAsync(@Nonnull
                                                                                                 String userToken,
                                                                                                 RequestOptions requestOptions)

Delete the user profile and all its associated data.

Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means that if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.

It might take a couple hours before for the deletion request to be fully processed.

Parameters:

userToken - userToken representing the user for which to delete the Personalization profile and associated data.

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getConfig

public ConfigBase getConfig()

Get Client's configuration