Jun 23, 2025
Create or update a batch of Recommend Rules
Create or update a batch of Recommend Rules
Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same objectID already exists.
You may also specify true for clearExistingRules, in which case the batch will atomically replace all the existing Recommend Rules.
Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a source item instead of a query. The main differences are the following:
- Conditions
patternandanchoringare unavailable. - Condition
filterstriggers if the source item matches the specified filters. - Condition
filtersaccepts numeric filters. - Consequence
paramsonly covers filtering parameters. - Consequence
automaticFacetFiltersdoesn’t require a facet value placeholder (it tries to match the data source item’s attributes instead).
Usage
Required ACL:
editSettings
Copy
1
2
3
4
5
6
7
8
9
10
from algoliasearch.recommend.client import RecommendClientSync
from json import loads
# In an asynchronous context, you can use RecommendClient instead, which exposes the exact same methods.
client = RecommendClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
response = client.batch_recommend_rules(
index_name="ALGOLIA_INDEX_NAME",
model="related-products",
)
Did you find this page helpful?