Combining Multiple Consequences

Imagine you have a movie database website, where users can search movies by title, actors, or director. Some prolific actors, like Clint Eastwood, also have a rich filmography as a director, and not everyone searching for “clint eastwood” might be looking for the same thing. For example, people looking only for movies directed by Clint Eastwood might search for “clint eastwood director”, hoping to filter out every movie that Clint Eastwood plays in, but didn’t direct.

In this case, you wouldn’t be interested in the word “director for textual search purposes, but as a cue to set a filter. You would therefore want to remove the word “director” from the search query so that the engine doesn’t textually look for records matching that word. You can achieve this by combining several consequences in your Rule.

Dataset Example

Let’s say we have the following dataset. Some movies have Clint Eastwood as an actor, some as a director, and some have both.

Copy
[
  {
    "title": "The Good, the Bad and the Ugly",
    "director": "Sergio Leone",
    "actors": ["Clint Eastwood", "Lee Van Cleef", "Elli Wallach"]
  },
  {
    "title": "Dirty Harry",
    "director": "Don Siegel",
    "actors": ["Clint Eastwood", "Andy Robinson", "Harry Guardino"]
  },
  {
    "title": "Million Dollar Baby",
    "director": "Clint Eastwood",
    "actors": ["Clint Eastwood", "Hilary Swank", "Morgan Freeman"]
  },
  {
    "title": "Invictus",
    "director": "Clint Eastwood",
    "actors": ["Morgan Freeman", "Matt Damon", "Tony Kgoroge"]
  }
]

If someone searches for “clint eastwood”, they would retrieve all movies by or with Clint Eastwood, even if they were only interested in movies with Clint Eastwood as the director. You could solve this problem with faceting, by setting director as an attribute for faceting and providing a refinement list with its own search input on your front end.

Yet, an even better way of helping your end user would be to make your search smart and look only for movies where director is equal to “Clint Eastwood” whenever they type “clint eastwood director”. To achieve this, you first need to set director in your list of attributes for faceting. Then, you can create a new Rule that filters on matching attributes.

Concretely, you’ll need to create two consequences whenever a user types in “clint eastwood director”:

filter all results with director
remove the word “director” from the search

Using the API

First, you need to set director as attributesForFaceting. This happens at indexing time.

Copy

1
2
3
4
5
$index->setSettings([
  'attributesForFaceting' => [
    "director"
  ]
]);

1
2
3
4
5
6
7
let settings = Settings()
  .set(\.attributesForFaceting, to: ["director"])
index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
IndexSettings settings = new IndexSettings
{
    AttributeForDistinct = "director"
};

index.SetSettings(settings);

// Asynchronous
await index.SetSettingsAsync(settings);

Then, you can set a Rule that detects the term “director” in a query whenever it comes after a term that matches the name of a director, and applies a filter on facet value director:'Clint Eastwood'. For this, you need to use the saveRule method.

However, setting the Rule isn’t enough. Even when you set a Rule, the engine still tries to match on the terms of the query. If a user searches for “clint eastwood director”, even if your Rule applies, the engine will look for the word “director” in the records. With our dataset, this would return no results at all. This is where combining consequences comes in handy.

You can add another consequence, to remove the word “director” from the query, when this Rule applies. This way, it won’t be used as a search term, only for filtering purposes.

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
$rule = [
  'objectID' => 'director-rule',
  'condition' => [
    'pattern'   => '{facet:director} director',
    'anchoring' => 'contains',
  ],
  'consequence' => [
    'params' => [
      'automaticFacetFilters' => ['director'],
      'query' => [
        'edits' => [
          [
            'type' => 'remove',
            'delete' => 'director'
          ]
        ]
      ]
    ]
  ]
];

$response = $index->saveRule($rule);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
rule = {
  objectID: 'director-rule',
  conditions: [{
    pattern: '{facet:director} director',
    anchoring: 'contains'
  }],
  consequence: {
    params: {
      automaticFacetFilters: ['director'],
      query: {
        edits: [
          {
            type: 'remove',
            delete: 'director'
          }
        ]
      }
    }
  }
}

index.save_rule(rule)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const rule = {
  objectID: 'director-rule',
  conditions: [{
    pattern: '{facet:director} director',
    anchoring: 'contains'
  }],
  consequence: {
    params: {
      automaticFacetFilters: 'director',
      query: {
        edits: [
          type: 'remove',
          delete: 'director'
        ]
      }
    }
  }
};

index.saveRule(rule, (err, content) => {
  if (err) throw err;
  console.log(content);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
rule = {
    'objectID': 'director-rule',
    'conditions': [{
        'pattern': '{facet:director} director',
        'anchoring': 'contains'
    }],
  'consequence': {
        'params': {
            'automaticFacetFilters': ['director'],
            'query': {
                'edits': [{
                    'type': 'remove',
                    'delete': 'director'
                }]
            }
        }
    }
}

response = index.save_rule(rule)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
let rule = Rule(objectID: "director-rule")
  .set(\.conditions, to: [
    Rule.Condition()
      .set(\.anchoring, to: .contains)
      .set(\.pattern, to: .literal("{facet:director} director"))
  ])
  .set(\.consequence, to: Rule.Consequence()
    .set(\.automaticFacetFilters, to: [.init(attribute: "director")])
    .set(\.queryTextAlteration, to: .edits([.remove("director")]))
  )

index.saveRule(rule) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
var rule = new Rule
{
  ObjectID = "director-rule",
  Conditions = new List<Condition> { Anchoring = "contains", Pattern = "{facet:director} director" } },
  Consequence = new Consequence
  {
    Params = new ConsequenceParams
    {
      AutomaticFacetFilters = new List<AutomaticFacetFilter>
      {
        new AutomaticFacetFilter { Facet = "director" }
      },
      Query = new ConsequenceQuery
      {
          Edits = new List<Edit>
          {
              new Edit { Type = EditType.Remove, Delete = "director" }
          }
      }
    }
  }
};

index.SaveRule(rule);

// Asynchronous
await index.SaveRuleAsync(rule);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Condition condition =
        new Condition().setPattern("{facet:director} director").setAnchoring("contains");

ConsequenceParams params =
        new ConsequenceParams()
                .setAutomaticFacetFilters(Collections.singletonList(new AutomaticFacetFilter("director")))
                .setConsequenceQuery(
                        new ConsequenceQuery()
                                .setEdits(Collections.singletonList(new Edit().setDelete("director"))));

Consequence consequence = new Consequence().setParams(params);

Rule rule =
        new Rule().setObjectID("director-rule").setConditions(Collections.singletonList(condition)).setConsequence(consequence);

index.saveRule(rule);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
rule := search.Rule{
  ObjectID:  "director-rule",
  Conditions: []search.RuleCondition{{Anchoring: search.Contains, Pattern: "{facet:director} director"}},
  Consequence: search.RuleConsequence{
    Params: &search.RuleParams{
      AutomaticFacetFilters: []search.AutomaticFacetFilter{{Facet: "director"}},
      Query: search.NewRuleQueryObject(
        search.RuleQueryObjectQuery{
          Edits: []search.QueryEdit{search.RemoveEdit("director")},
        },
      ),
    },
  },
}

res, err := index.SaveRule(rule)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
val ruleToSave = Rule(
  objectID = "director-rule",
  conditions = Some(Seq(Condition(
    pattern = "{facet:director} director",
    anchoring = "contains"
  ))),
  consequence = Consequence(
    params = Seq(
      Map("automaticFacetFilters" -> Seq(
        AutomaticFacetFilters("director")
      )),
      Map(
        "query" -> Map(
          "edits" -> Seq(
            Edit("remove", "director")
          )
        )
      )
    )
  ),
)

client.execute {
  save rule ruleToSave inIndex "index_name"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
val director = Attribute("director")
val rules = rules {
    rule(
        "director_rule",
        Condition(Contains, Facet(director)),
        Consequence(
            automaticFacetFilters { +director },
            edits = edits { +"director" }
        )
    )
}

index.saveRules(rules).then(() => {
  // done
});

Using the Dashboard

You can also add your Rules in your Algolia dashboard.

Select the Search product icon on your dashboard and then select your index.
Click the Configuration tab.
In the Facets subsection of Filtering and Faceting, click the “Add an attribute” button and select the director attribute from the dropdown.
Select the Rules section from the left sidebar menu in the Algolia dashboard.
Under the heading Rules, select the index you are adding a Rule to.
Select Create your first rule or New rule. In the dropdown, click on the Manual Editor option.
In the Condition(s) section, keep Query toggled on, select Contains in the dropdown, and select the option Add Facet “director” from the input dropdown. {facet:director} should then be displayed in the input.
In the Consequence(s) section:
- Click the Add consequence button and select Filter Matching Attributes (or Filter/Boost Matching Attributes).
- In the Filter input that appears, select the option Add Facet “director” in the dropdown.
- Click the Add consequence button again and select Remove Word.
- In the input that appears, select Remove “{facet:director}”.
Don’t forget to save your changes.

Did you find this page helpful?

Combining Multiple Consequences

On this page

Dataset Example

Using the API

Using the Dashboard

On this page