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]

Deletes a Recommend rule from a recommendation scenario.

Deletes a Recommend rule from a recommendation scenario.

Required API Key ACLs:

  • editSettings

Value parameters

indexName

Name of the index on which to perform the operation.

model

Recommend model.

objectID

Unique record identifier.

Attributes

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

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

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

Required API Key ACLs:

  • settings

Value parameters

indexName

Name of the index on which to perform the operation.

model

Recommend model.

objectID

Unique record identifier.

Attributes

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

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.

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.

Required API Key ACLs:

  • editSettings

Value parameters

indexName

Name of the index on which to perform the operation.

model

Recommend model.

taskID

Unique task identifier.

Attributes

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

Retrieves recommendations from selected AI models.

Retrieves recommendations from selected AI models.

Required API Key ACLs:

  • search

Attributes

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

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

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

Required API Key ACLs:

  • settings

Value parameters

indexName

Name of the index on which to perform the operation.

model

Recommend model.

Attributes

Inherited methods

override def close(): Unit

Attributes

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