Package com.algolia.api

Class RecommendClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.RecommendClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class RecommendClient
extends ApiClient

Constructor Summary

Constructors

Constructor	Description
RecommendClient(String appId, String apiKey)
RecommendClient(String appId, String apiKey, ClientOptions options)

Method Summary

Modifier and Type	Method	Description
Object	customDelete(String path)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customGet(String path)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPost(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPut(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
DeletedAtResponse	deleteRecommendRule(String indexName, RecommendModels model, String objectID)	Deletes a Recommend rule from a recommendation scenario.
DeletedAtResponse	deleteRecommendRule(String indexName, RecommendModels model, String objectID, RequestOptions requestOptions)	Deletes a Recommend rule from a recommendation scenario.
CompletableFuture<DeletedAtResponse>	deleteRecommendRuleAsync(String indexName, RecommendModels model, String objectID)	(asynchronously) Deletes a Recommend rule from a recommendation scenario.
CompletableFuture<DeletedAtResponse>	deleteRecommendRuleAsync(String indexName, RecommendModels model, String objectID, RequestOptions requestOptions)	(asynchronously) Deletes a Recommend rule from a recommendation scenario.
GetRecommendationsResponse	getRecommendations(GetRecommendationsParams getRecommendationsParams)	Retrieves recommendations from selected AI models.
GetRecommendationsResponse	getRecommendations(GetRecommendationsParams getRecommendationsParams, RequestOptions requestOptions)	Retrieves recommendations from selected AI models.
CompletableFuture<GetRecommendationsResponse>	getRecommendationsAsync(GetRecommendationsParams getRecommendationsParams)	(asynchronously) Retrieves recommendations from selected AI models.
CompletableFuture<GetRecommendationsResponse>	getRecommendationsAsync(GetRecommendationsParams getRecommendationsParams, RequestOptions requestOptions)	(asynchronously) Retrieves recommendations from selected AI models.
RecommendRule	getRecommendRule(String indexName, RecommendModels model, String objectID)	Retrieves a Recommend rule that you previously created in the Algolia dashboard.
RecommendRule	getRecommendRule(String indexName, RecommendModels model, String objectID, RequestOptions requestOptions)	Retrieves a Recommend rule that you previously created in the Algolia dashboard.
CompletableFuture<RecommendRule>	getRecommendRuleAsync(String indexName, RecommendModels model, String objectID)	(asynchronously) Retrieves a Recommend rule that you previously created in the Algolia dashboard.
CompletableFuture<RecommendRule>	getRecommendRuleAsync(String indexName, RecommendModels model, String objectID, RequestOptions requestOptions)	(asynchronously) Retrieves a Recommend rule that you previously created in the Algolia dashboard.
GetRecommendTaskResponse	getRecommendStatus(String indexName, RecommendModels model, Long taskID)	Checks the status of a given task.
GetRecommendTaskResponse	getRecommendStatus(String indexName, RecommendModels model, Long taskID, RequestOptions requestOptions)	Checks the status of a given task.
CompletableFuture<GetRecommendTaskResponse>	getRecommendStatusAsync(String indexName, RecommendModels model, Long taskID)	(asynchronously) Checks the status of a given task.
CompletableFuture<GetRecommendTaskResponse>	getRecommendStatusAsync(String indexName, RecommendModels model, Long taskID, RequestOptions requestOptions)	(asynchronously) Checks the status of a given task.
SearchRecommendRulesResponse	searchRecommendRules(String indexName, RecommendModels model)	Searches for Recommend rules.
SearchRecommendRulesResponse	searchRecommendRules(String indexName, RecommendModels model, RequestOptions requestOptions)	Searches for Recommend rules.
SearchRecommendRulesResponse	searchRecommendRules(String indexName, RecommendModels model, SearchRecommendRulesParams searchRecommendRulesParams)	Searches for Recommend rules.
SearchRecommendRulesResponse	searchRecommendRules(String indexName, RecommendModels model, SearchRecommendRulesParams searchRecommendRulesParams, RequestOptions requestOptions)	Searches for Recommend rules.
CompletableFuture<SearchRecommendRulesResponse>	searchRecommendRulesAsync(String indexName, RecommendModels model)	(asynchronously) Searches for Recommend rules.
CompletableFuture<SearchRecommendRulesResponse>	searchRecommendRulesAsync(String indexName, RecommendModels model, RequestOptions requestOptions)	(asynchronously) Searches for Recommend rules.
CompletableFuture<SearchRecommendRulesResponse>	searchRecommendRulesAsync(String indexName, RecommendModels model, SearchRecommendRulesParams searchRecommendRulesParams)	(asynchronously) Searches for Recommend rules.
CompletableFuture<SearchRecommendRulesResponse>	searchRecommendRulesAsync(String indexName, RecommendModels model, SearchRecommendRulesParams searchRecommendRulesParams, RequestOptions requestOptions)	(asynchronously) Searches for Recommend rules.

Methods inherited from class com.algolia.ApiClient

close, executeAsync, executeAsync

Methods inherited from class java.lang.Object

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

Constructor Details

RecommendClient

public RecommendClient(String appId,
 String apiKey)

RecommendClient

public RecommendClient(String appId,
 String apiKey,
 ClientOptions options)

Method Details

customDelete

public Object customDelete(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                    throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 String path,
 Map<String,Object> parameters)
                    throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 String path,
 RequestOptions requestOptions)
                    throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 String path)
                    throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                            throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path)
                                            throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 String path,
 Map<String,Object> parameters)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 String path,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 String path)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                  throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                  throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path,
 RequestOptions requestOptions)
                  throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path)
                  throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                          throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path)
                                          throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path)
                 throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path)
                                         throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRecommendRule

public DeletedAtResponse deleteRecommendRule(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

Deletes a Recommend rule from a recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

objectID - Unique record identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRecommendRule

public DeletedAtResponse deleteRecommendRule(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 String objectID)
                                      throws AlgoliaRuntimeException

Deletes a Recommend rule from a recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

objectID - Unique record identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRecommendRuleAsync

public CompletableFuture<DeletedAtResponse> deleteRecommendRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) Deletes a Recommend rule from a recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

objectID - Unique record identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRecommendRuleAsync

public CompletableFuture<DeletedAtResponse> deleteRecommendRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 String objectID)
                                                              throws AlgoliaRuntimeException

(asynchronously) Deletes a Recommend rule from a recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

objectID - Unique record identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendRule

public RecommendRule getRecommendRule(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

Retrieves a Recommend rule that you previously created in the Algolia dashboard.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

objectID - Unique record identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendRule

public RecommendRule getRecommendRule(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 String objectID)
                               throws AlgoliaRuntimeException

Retrieves a Recommend rule that you previously created in the Algolia dashboard.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

objectID - Unique record identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendRuleAsync

public CompletableFuture<RecommendRule> getRecommendRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) Retrieves a Recommend rule that you previously created in the Algolia dashboard.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

objectID - Unique record identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendRuleAsync

public CompletableFuture<RecommendRule> getRecommendRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 String objectID)
                                                       throws AlgoliaRuntimeException

(asynchronously) Retrieves a Recommend rule that you previously created in the Algolia dashboard.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

objectID - Unique record identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendStatus

public GetRecommendTaskResponse getRecommendStatus(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 Long taskID,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

taskID - Unique task identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendStatus

public GetRecommendTaskResponse getRecommendStatus(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 Long taskID)
                                            throws AlgoliaRuntimeException

Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

taskID - Unique task identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendStatusAsync

public CompletableFuture<GetRecommendTaskResponse> getRecommendStatusAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 Long taskID,
 RequestOptions requestOptions)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

taskID - Unique task identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendStatusAsync

public CompletableFuture<GetRecommendTaskResponse> getRecommendStatusAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 @Nonnull
 Long taskID)
                                                                    throws AlgoliaRuntimeException

(asynchronously) Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

taskID - Unique task identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendations

public GetRecommendationsResponse getRecommendations(@Nonnull
 GetRecommendationsParams getRecommendationsParams,
 RequestOptions requestOptions)
                                              throws AlgoliaRuntimeException

Retrieves recommendations from selected AI models.

Parameters:

getRecommendationsParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendations

public GetRecommendationsResponse getRecommendations(@Nonnull
 GetRecommendationsParams getRecommendationsParams)
                                              throws AlgoliaRuntimeException

Retrieves recommendations from selected AI models.

Parameters:

getRecommendationsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendationsAsync

public CompletableFuture<GetRecommendationsResponse> getRecommendationsAsync(@Nonnull
 GetRecommendationsParams getRecommendationsParams,
 RequestOptions requestOptions)
                                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves recommendations from selected AI models.

Parameters:

getRecommendationsParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRecommendationsAsync

public CompletableFuture<GetRecommendationsResponse> getRecommendationsAsync(@Nonnull
 GetRecommendationsParams getRecommendationsParams)
                                                                      throws AlgoliaRuntimeException

(asynchronously) Retrieves recommendations from selected AI models.

Parameters:

getRecommendationsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRecommendRules

public SearchRecommendRulesResponse searchRecommendRules(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 SearchRecommendRulesParams searchRecommendRulesParams,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

searchRecommendRulesParams - (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRecommendRules

public SearchRecommendRulesResponse searchRecommendRules(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 SearchRecommendRulesParams searchRecommendRulesParams)
                                                  throws AlgoliaRuntimeException

Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

searchRecommendRulesParams - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRecommendRules

public SearchRecommendRulesResponse searchRecommendRules(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRecommendRules

public SearchRecommendRulesResponse searchRecommendRules(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model)
                                                  throws AlgoliaRuntimeException

Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRecommendRulesAsync

public CompletableFuture<SearchRecommendRulesResponse> searchRecommendRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 SearchRecommendRulesParams searchRecommendRulesParams,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

searchRecommendRulesParams - (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRecommendRulesAsync

public CompletableFuture<SearchRecommendRulesResponse> searchRecommendRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 SearchRecommendRulesParams searchRecommendRulesParams)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

searchRecommendRulesParams - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRecommendRulesAsync

public CompletableFuture<SearchRecommendRulesResponse> searchRecommendRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRecommendRulesAsync

public CompletableFuture<SearchRecommendRulesResponse> searchRecommendRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 RecommendModels model)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call