Class FilterAction (1.7.0)

FilterAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)
  • Rule Condition:

    • No Condition][query_terms] provided is a global match.
    • 1 or more Condition][query_terms] provided is combined with OR operator.
  • Action Input: The request query and filter that will be applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.

  • Action Result: Filters the returned objects to be ONLY those that passed the filter.

Attribute

NameDescription
filter str
A filter to apply on the matching condition results. Supported features: - filter must be set. - Filter syntax is identical to SearchRequest.filter. See more details at the Retail Search `user guide `__. - To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2"))* *AND* *(colorFamilies: ANY("Red", "Blue"))*

Inheritance

builtins.object > proto.message.Message > FilterAction