SearchRecommendRulesParams

algoliasearch.recommend.SearchRecommendRulesParams
case class SearchRecommendRulesParams(query: Option[String], context: Option[String], page: Option[Int], hitsPerPage: Option[Int], enabled: Option[Boolean], filters: Option[String], facets: Option[Seq[String]], maxValuesPerFacet: Option[Int])

Recommend rules parameters.

Value parameters

context

Only search for rules with matching context.

enabled

Whether to only show rules where the value of their enabled property matches this parameter. If absent, show all rules, regardless of their enabled property.

facets

Include facets and facet values in the response. Use ['*'] to include all facets.

filters

Filter expression. This only searches for rules matching the filter expression.

hitsPerPage

Maximum number of hits per page. Algolia uses page and hitsPerPage to control how search results are displayed (paginated). - hitsPerPage: sets the number of search results (hits) displayed per page. - page: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is page=0, the second is page=1, and so on. For example, to display 10 results per page starting from the third page, set hitsPerPage to 10 and page to 2.

maxValuesPerFacet

Maximum number of values to return for each facet.

page

Requested page of the API response. Algolia uses page and hitsPerPage to control how search results are displayed (paginated). - hitsPerPage: sets the number of search results (hits) displayed per page. - page: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is page=0, the second is page=1, and so on. For example, to display 10 results per page starting from the third page, set hitsPerPage to 10 and page to 2.

query

Search query.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product