Create or replace a rule

If a rule with the specified object ID doesn’t exist, it’s created. Otherwise, the existing rule is replaced.

To create or update more than one rule, use the batch operation.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
from algoliasearch.search.client import SearchClientSync
from json import loads

# In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods.
client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.save_rule(
    index_name="ALGOLIA_INDEX_NAME",
    object_id="id1",
    rule={
        "objectID": "id1",
        "conditions": [
            {
                "pattern": "apple",
                "anchoring": "contains",
            },
        ],
        "consequence": {
            "params": {
                "filters": "brand:xiaomi",
            },
        },
    },
)
Did you find this page helpful?
Python API clients v4