algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.api/RecommendClient

RecommendClient

algoliasearch.api.RecommendClient
See theRecommendClient companion object
class RecommendClient(appId: String, apiKey: String, clientOptions: ClientOptions) extends ApiClient

Attributes

Companion
object
Graph
Supertypes
class ApiClient
trait AutoCloseable
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def customDelete[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$1: Manifest[T], ec: ExecutionContext): Future[T]

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

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

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customGet[T : Manifest](path: String, parameters: Option[Map[String, Any]], requestOptions: Option[RequestOptions])(implicit evidence$2: Manifest[T], ec: ExecutionContext): Future[T]

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

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

Value parameters

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPost[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$3: Manifest[T], ec: ExecutionContext): Future[T]

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

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

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def customPut[T : Manifest](path: String, parameters: Option[Map[String, Any]], body: Option[Any], requestOptions: Option[RequestOptions])(implicit evidence$4: Manifest[T], ec: ExecutionContext): Future[T]

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

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

Value parameters

body

Parameters to send with the custom request.

parameters

Query parameters to apply to the current query.

path

Path of the endpoint, anything after "/1" must be specified.

Attributes

def deleteRecommendRule(indexName: String, model: RecommendModels, objectID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[DeletedAtResponse]

Delete a Recommend rule.

Delete a Recommend rule.

Value parameters

indexName

Index on which to perform the request.

model

Recommend models.

objectID

Unique record (object) identifier.

Attributes

def getRecommendRule(indexName: String, model: RecommendModels, objectID: String, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[RuleResponse]

Return a Recommend rule.

Return a Recommend rule.

Value parameters

indexName

Index on which to perform the request.

model

Recommend models.

objectID

Unique record (object) identifier.

Attributes

def getRecommendStatus(indexName: String, model: RecommendModels, taskID: Long, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[GetRecommendTaskResponse]

Some operations, such as deleting a Recommend rule, will respond with a taskID value. Use this value here to check the status of that task.

Some operations, such as deleting a Recommend rule, will respond with a taskID value. Use this value here to check the status of that task.

Value parameters

indexName

Index on which to perform the request.

model

Recommend models.

taskID

Unique identifier of a task. Numeric value (up to 64bits).

Attributes

def getRecommendations(getRecommendationsParams: GetRecommendationsParams, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[GetRecommendationsResponse]

Returns results from either recommendation or trending models: - Recommendations are provided by the Related Products and Frequently Bought Together models - Trending models are Trending Items and Trending Facet Values.

Returns results from either recommendation or trending models: - Recommendations are provided by the Related Products and Frequently Bought Together models - Trending models are Trending Items and Trending Facet Values.

Attributes

def searchRecommendRules(indexName: String, model: RecommendModels, searchRecommendRulesParams: Option[SearchRecommendRulesParams], requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[SearchRecommendRulesResponse]

List Recommend rules.

List Recommend rules.

Value parameters

indexName

Index on which to perform the request.

model

Recommend models.

Attributes

Inherited methods

override def close(): Unit

Attributes

Definition Classes
ApiClient -> AutoCloseable
Inherited from:
ApiClient
Generated with