Package com.algolia.model.recommend

Class ParamsConsequence

java.lang.Object
com.algolia.model.recommend.ParamsConsequence
public class ParamsConsequence extends Object
Filter or boost recommendations matching a facet filter.

  • Constructor Details

    • ParamsConsequence

      public ParamsConsequence()

  • Method Details

    • setAutomaticFacetFilters

      public ParamsConsequence setAutomaticFacetFilters(List<AutoFacetFilter> automaticFacetFilters)

    • addAutomaticFacetFilters

      public ParamsConsequence addAutomaticFacetFilters(AutoFacetFilter automaticFacetFiltersItem)

    • getAutomaticFacetFilters

      @Nullable public List<AutoFacetFilter> getAutomaticFacetFilters()
      Filter recommendations that match or don't match the same `facet:facet_value` combination as the viewed item.

    • setFilters

      public ParamsConsequence setFilters(String filters)

    • getFilters

      @Nullable public String getFilters()
      Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** ` `, where `` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `: TO ` where `` and `` are the lower and upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).

    • setOptionalFilters

      public ParamsConsequence setOptionalFilters(List<String> optionalFilters)

    • addOptionalFilters

      public ParamsConsequence addOptionalFilters(String optionalFiltersItem)

    • getOptionalFilters

      @Nullable public List<String> getOptionalFilters()
      Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you're using a negative filter `facet:-value`, matching records rank after records that don't match.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object