> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Rules overview
> How to use Algolia's Rules feature to create flexible and dynamic search results.
export const SearchQuery = () =>
search query
;
export const Index = () =>
index
;
export const Filter = () =>
filter
;
export const Facet = () =>
facet
;
Search needs to be flexible.
Product promotions should be seamless:
search setting adjustments or record updates aren't needed.
If one of your products isn't appearing where you want it to in your search results,
you should be able to reposition it.
Rules let you make precise and (if desired) temporary modifications to your search results.
Relevance and settings provide the general structure for your search results.
**Rules let you optimize and dynamically adjust that structure.**
Rules are no substitute for a well-configured index.
Make sure you [adjust your general relevance](/doc/guides/managing-results/relevance-overview) before adding rules.
## Index rules and composition rules
Algolia uses two different types of rules: index rules and composition rules.
This section describes index rules.
For more information about composition rules, see [Smart Groups](/doc/guides/managing-results/compositions/smart-groups).
## What are rules used for?
Rules let you make precise, predetermined changes to your search results.
For example, you can pin or hide items,
boost or bury categories,
or results based on the query.
You can also enable rules for a fixed time,
making rules a great way of implementing sales or promotions.
**Rules are typically used either for merchandising or fine-tuning your search and relevance.**
For more information about typical uses for rules,
see [Merchandising](/doc/guides/managing-results/rules/merchandising-and-promoting) and [Detecting intent](/doc/guides/managing-results/rules/detecting-intent).
The maximum number of rules per index depends on your [Algolia plan](https://www.algolia.com/pricing).
## Rule structure
Three elements define a rule:
conditions, consequences, and a validity period.
Of these three elements, only a consequence is mandatory.
**When a rule's condition is satisfied, Algolia applies its consequences**.
If a rule has no conditions (a [conditionless rule](#conditionless-rules)),
Algolia always applies its consequences.
For more information, see:
* [Implement rules](/doc/guides/managing-results/rules/rules-overview/in-depth/implementing-rules)
* [Troubleshoot rules](/doc/guides/managing-results/rules/rules-overview/in-depth/debugging-rules)
## Conditions
A rule can have up to 25 conditions.
A rule with several conditions activates when any condition is satisfied.
In other words, conditions have an `or` relationship to one another.
Conditions may contain a pattern string, anchoring, context, or filters.
To determine if a rule's consequences apply:
1. Algolia compares the user's query to the condition's pattern.
It bases the comparison on the condition's anchoring.
Values for anchoring are:
`is`, `contains`, `starts with`, and `ends with`.
The anchoring determines what part of the query the pattern must match:
all of it, part of it, the beginning, or the end.
If you enable [`alternatives`](/doc/rest-api/search/save-rule#body-condition-alternatives) in the condition, user queries can match the condition's pattern,
even if the query is a plural, synonym, or typo of the pattern.
Without alternatives, queries must precisely match the condition's pattern and anchoring.
2. It compares the condition's filters to the [filters](/doc/guides/managing-results/refine-results/filtering/how-to/filter-by-attributes#filter-by-string) applied to the search.
3. It compares the condition's context to the search's [`ruleContexts`](/doc/api-reference/api-parameters/ruleContexts).
If a [single condition includes a pattern string, filters, and a context](#pattern-filters-and-context),
a search must match all three for the condition to be satisfied.
With three conditions, a rule activates if any is met.
If a condition has a pattern string that set to an empty string with `is` anchoring,
Algolia applies the rule if users haven't yet entered a query.
If a condition has neither pattern, anchoring, context, or filters, it's a conditionless rule, and Algolia applies it to every search.
Rules can respond to different types of conditions:
* [Query patterns](#rules-responding-to-user-queries)
* [Filters](#rules-responding-to-applied-filters)
* [Context-only](#context-only-rules)
* [Conditionless](#conditionless-rules).
### Example conditions
#### Using a pattern with is anchoring
Trigger a rule with this condition whenever the query string is the word `sale` and nothing else.
If the query contains other words, the rule isn't triggered.
```json JSON icon=braces theme={"system"}
{
"pattern": "sale",
"anchoring": "is"
}
```
#### A pattern with contains anchoring
Trigger a rule with this condition whenever the query string contains the word `featured`.
The query can include other words.
```json JSON icon=braces theme={"system"}
{
"pattern": "featured",
"anchoring": "contains"
}
```
#### A context
Trigger a rule when the search includes `mobile` in the [`ruleContexts`](/doc/api-reference/api-parameters/ruleContexts).
```json JSON icon=braces theme={"system"}
{
"context": "mobile"
}
```
#### Filters
Trigger a rule when the filter `{ "filters": "category:TV" }` applies to the query.
```json JSON icon=braces theme={"system"}
{
"filters": "category:TV"
}
```
The filters condition rejects an `OR` combination of different attributes.
For example, `"filters": "brand:Guess OR color:orange"` returns an error.
You also can't use numeric filters in conditions.
#### Pattern, filters, and context
Trigger a rule when:
* The query contains the word `featured`
* [`filters`](/doc/api-reference/api-parameters/filters) includes `category:TV`
* [`ruleContexts`](/doc/api-reference/api-parameters/ruleContexts) includes `mobile`.
```json JSON icon=braces theme={"system"}
{
"pattern": "featured",
"anchoring": "contains",
"filters": "category:TV",
"context": "mobile"
}
```
#### An empty string pattern
Trigger a rule when there is an empty search.
The rule turns off as soon as a user starts typing.
```json JSON icon=braces theme={"system"}
{
"pattern": "",
"anchoring": "is"
}
```
## Consequences
Though conditions aren't required,
rules must have at least one consequence.
Consequences change the search results.
Possible consequences are:
* **Pin an Item**. Insert an item at a specific position. If the item is already in the results, it moves to that position.
* **Hide an Item**. Remove a specific result from the list of results.
* **Add a Query Parameter**. Add a query parameter to your user's search. For example, you could decrease the [`aroundRadius`](/doc/api-reference/api-parameters/aroundRadius) if your user's query includes the words "near me".
* **Remove Word**. Remove a specific word from your user's (for search, not display purposes).
* **Replace Word**. Replace a word from your user's search query with another word (for search, not display purposes).
* **Replace Query**. Replace the entire user search query with another query (for search, not display purposes).
* **Return Custom Data**. Add custom JSON data to the search response.
* **Filter/Boost Matching Attributes**. Apply [`filters`](/doc/api-reference/api-parameters/filters) or [`optionalFilters`](/doc/api-reference/api-parameters/optionalFilters) matching the query to the results.
For more information, see:
* [Rules consequences](/doc/guides/managing-results/rules/rules-overview/in-depth/implementing-rules#consequence—adapt-the-results)
* [Merchandising](/doc/guides/managing-results/rules/merchandising-and-promoting)
## Validity period
If you want to apply a rule temporarily, you can set a validity period.
The validity period determines how long a rule remains active.
Use this to ensure promotions and sales end automatically.
## Rules responding to user queries
Rules can parse user queries and apply consequences if the query matches the rule's condition.
Queries can match with conditions in the following ways:
* **is**: the entire query matches the condition string.
* **contains**: the entire query contains the condition string
* **starts with**: the query starts with the condition string.
* **ends with**: the query ends with the condition string.
To [trigger a rule on an empty query](/doc/guides/managing-results/rules/detecting-intent) use a [context-only rule](#context-only-rules),
use `is` anchoring but set the text to an empty string.
## Rules responding to applied filters
If a rule's condition includes filters, Algolia applies that rule's consequences only if the filters in a search's query parameters exactly match the condition's filters.
For example, Algolia only triggers a rule with the condition `{"filters": "category:TV"}`, only if the `category` value is `TV`.
Other filters like `"category:Smartphone"` or `"category:TV OR category:Smartphone"` don't trigger the rule.
**The primary goal of this condition is to create rules that trigger on specific category pages or when a user applies specific filters.**
For example, you can define a rule with the condition `{"filters": "category:TV"}` and a consequence to promote specific items.
The rule triggers when a user lands on the TV category page.
For more information, see [Filters can trigger rules](/doc/guides/managing-results/rules/rules-overview/in-depth/implementing-rules#filters-can-trigger-rules).
To use an attribute in a rule condition with filters,
you must first [declare it in `attributesForFaceting`](/doc/guides/managing-results/refine-results/faceting/how-to/declaring-attributes-for-faceting).
## Context-only rules
If a rule's condition only includes a context,
the consequence only applies if the rule's context exactly matches a value in the [`ruleContexts`](/doc/api-reference/api-parameters/ruleContexts) parameter of a user's search.
### What are contexts?
Contexts provide information about your user's search environment:
for example, what section of a website they're currently visiting or what device they're using.
A context can be any string value that doesn't include whitespace characters.
The search condition it specifies must be identifiable at search time.
You need to implement logic for sending contexts with queries.
You can pass contexts through the [`ruleContexts`](/doc/api-reference/api-parameters/ruleContexts) search parameter.
### Implementation
To create a rule with a context condition, you must:
1. Create the rule (with the dashboard or the API).
2. Conditionally assign its associated context to your user's searches.
To clarify the process, consider the example of an electronics store.
By looking at [analytics tags](/doc/guides/search-analytics/guides/segments), it's clear that mobile users rarely find what they're searching for on the first page of results.
Testing indicates this is because vague searches for accessories like "chargers" or "cases" return laptop chargers and cases first.
If mobile users search for cases, you can assume that they prefer phone cases over laptop cases.
If they search for chargers, phone chargers should show up first.
To remedy this, add a rule that promotes all items with the "phone" tag but only for users searching from a mobile platform.
To learn more, see [Using rules to customize search results by device](/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform).
## Conditionless rules
Rules without conditions apply to every search.
They're an effective way of temporarily modifying search for a predefined time, for example, for seasonal promotions.
For more information, see [Add default search parameters with rules](/doc/guides/managing-results/rules/rules-overview/how-to/add-default-search-parameters-with-rules).
You can create conditionless rules from the Algolia dashboard or with one of the API clients.
### Create a conditionless rule from the dashboard
1. Select the **Search** product icon in the Algolia dashboard.
2. Select the **Rules** section from the left sidebar menu in the [dashboard](https://dashboard.algolia.com/rules).
3. Under the heading **Rules**, select the index you're adding a rule to.
4. Select **Create your first rule** or **New rule**. In the drop-down menu, click **Manual Editor**. You can't create conditionless rules with the Visual Editor.
5. In the **Condition(s)** section, click the **Remove** button with the trash can icon at the top right of the condition.
6. In the **Consequence(s)** section, set the relevant consequences.
7. If this rule only applies for a certain period, select a time range in **Additional Settings**, under **Timeframe in UTC**.
8. If you want to forward the rule to replicas or other indices, toggle **Copy this rule to other indices** and enter the relevant names.
9. Save your changes.
### Create a conditionless rule with an API client
To run the code examples on this page, [install the latest API client](/doc/libraries/sdk/install).
To create a conditionless rule with an API client,
use the [`saveRule`](/doc/libraries/sdk/methods/search/save-rule) method on a rule object but without a condition.
```cs C# theme={"system"}
namespace Algolia;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Text.Json;
using Algolia.Search.Clients;
using Algolia.Search.Http;
using Algolia.Search.Models.Search;
class UseConditionlessRule
{
async Task Main(string[] args)
{
var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));
var objectID = "a-rule-id";
var rule = new Rule
{
ObjectID = objectID,
Consequence =
new Consequence( /* Set relevant consequence */
),
// Set validity (optional)
Validity = [new TimeRange { From = 1688774400L, Until = 1738972800L }],
};
await client.SaveRuleAsync("INDEX_NAME", objectID, rule);
}
}
```
```dart Dart theme={"system"}
import 'package:algolia_client_search/algolia_client_search.dart';
void useConditionlessRule() async {
final client =
SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');
final objectID = "a-rule-id";
final rule = Rule(
objectID: objectID,
consequence: Consequence(
// Set relevant consequence
),
// Set validity (optional)
validity: [TimeRange(from: 1688774400, until: 1738972800)]);
await client.saveRule(
indexName: "INDEX_NAME",
objectID: objectID,
rule: rule,
);
}
```
```go Go theme={"system"}
package main
import (
"github.com/algolia/algoliasearch-client-go/v4/algolia/search"
"github.com/algolia/algoliasearch-client-go/v4/algolia/utils"
)
func useConditionlessRule() {
client, err := search.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
objectID := "a-rule-id"
rule := search.NewRule(
objectID,
*search.NewConsequence( /* Set relevant consequence */ ),
). // Set validity (optional)
SetValidity(
[]search.TimeRange{{
From: utils.ToPtr(int64(1_688_774_400)),
Until: utils.ToPtr(int64(1_738_972_800)),
}},
)
_, err = client.SaveRule(client.NewApiSaveRuleRequest(
"INDEX_NAME", objectID, rule))
if err != nil {
panic(err)
}
}
```
```java Java theme={"system"}
package com.algolia;
import com.algolia.api.SearchClient;
import com.algolia.config.*;
import com.algolia.model.search.*;
import java.util.List;
public class useConditionlessRule {
public static void main(String[] args) throws Exception {
try (SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")) {
String objectID = "a-rule-id";
Rule rule = new Rule().setObjectID(objectID).setConsequence(new Consequence /* Set relevant consequence */());
// Set validity (optional)
rule.setValidity(List.of(new TimeRange().setFrom(1688774400L).setUntil(1738972800L)));
client.saveRule("INDEX_NAME", objectID, rule);
} catch (Exception e) {
System.out.println("An error occurred: " + e.getMessage());
}
}
}
```
```js JavaScript theme={"system"}
import { algoliasearch } from 'algoliasearch';
import type { Rule } from 'algoliasearch';
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
const objectID = 'a-rule-id';
const rule: Rule = {
objectID,
consequence: {
// Set relevant consequence
},
};
// Set validity (optional)
rule.validity = [
{
from: 1688774400,
until: 1738972800,
},
];
await client.saveRule({ indexName: 'indexName', objectID: objectID, rule: rule });
```
```kotlin Kotlin theme={"system"}
import com.algolia.client.api.SearchClient
import com.algolia.client.configuration.*
import com.algolia.client.extensions.*
import com.algolia.client.model.search.*
import com.algolia.client.transport.*
suspend fun useConditionlessRule() {
val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
val objectID = "a-rule-id"
val rule =
Rule(
objectID = objectID,
consequence =
Consequence(
// Set relevant consequence
),
// Set validity (optional)
validity = listOf(TimeRange(from = 1_688_774_400, until = 1_738_972_800)),
)
client.saveRule(indexName = "INDEX_NAME", objectID = objectID, rule = rule)
}
```
```php PHP theme={"system"}
setObjectID($objectID)
->setConsequence(new Consequence(/* Set relevant consequence */))
;
// Set validity (optional)
$rule->setValidity(
[
(new TimeRange())
->setFrom(1688774400)
->setUntil(1738972800),
]
);
$client->saveRule(
'INDEX_NAME',
$objectID,
$rule,
);
```
```python Python theme={"system"}
from algoliasearch.search.client import SearchClientSync
from algoliasearch.search.models.consequence import Consequence
from algoliasearch.search.models.rule import Rule
from algoliasearch.search.models.time_range import TimeRange
_client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
object_id = "a-rule-id"
rule = Rule(
object_id=object_id,
consequence=Consequence(
# Set relevant consequence
),
)
# Set validity (optional)
rule.validity = [
TimeRange(
var_from=1688774400,
until=1738972800,
),
]
_client.save_rule(
index_name="INDEX_NAME",
object_id=object_id,
rule=rule,
)
```
```ruby Ruby theme={"system"}
require "algolia"
client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
object_id = "a-rule-id"
rule = Algolia::Search::Rule.new(
object_id: object_id,
consequence: Algolia::Search::Consequence.new
# Set relevant consequence
)
# Set validity (optional)
rule.validity = [
Algolia::Search::TimeRange.new(
from: 1688774400,
until: 1738972800
)
]
client.save_rule("INDEX_NAME", algolia_object_id, rule)
```
```scala Scala theme={"system"}
import scala.concurrent.ExecutionContext.Implicits.global
import scala.concurrent.Future
import algoliasearch.api.SearchClient
import algoliasearch.config.*
import algoliasearch.extension.SearchClientExtensions
import algoliasearch.search.{Consequence, Rule, TimeRange}
def useConditionlessRule(): Future[Unit] = {
val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
val objectID = "a-rule-id";
val rule = Rule(
objectID = objectID,
consequence = Consequence(
// Set relevant consequence
),
// Set validity (optional)
validity = Some(
Seq(
TimeRange(
from = Some(1_688_774_400),
until = Some(1_738_972_800)
)
)
)
)
client
.saveRule(
indexName = "INDEX_NAME",
objectID = objectID,
rule = rule
)
.map { response =>
println(response)
}
.recover { case ex: Exception =>
println(s"An error occurred: ${ex.getMessage}")
}
}
```
```swift Swift theme={"system"}
import Foundation
#if os(Linux) // For linux interop
import FoundationNetworking
#endif
import AlgoliaCore
import AlgoliaSearch
func useConditionlessRule() async throws {
let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
let objectID = "a-rule-id"
let rule = Rule(
objectID: objectID,
consequence: SearchConsequence(
// Set relevant consequence
),
// Set validity (optional)
validity: [
SearchTimeRange(
from: 1_688_774_400,
until: 1_738_972_800
),
]
)
try await client.saveRule(indexName: "INDEX_NAME", objectID: objectID, rule: rule)
}
```
## Context-only and conditionless rules deactivate consequences
Since conditionless and context-only rules don't have a query as a condition, these consequences are deactivated.
| Consequence | Why is it deactivated? |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Pin an item | The same item would always appear in the same position, usually at the top, for all queries and all users. Instead, consider [adding a banner](/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/add-banners) to promote items you want to pin. |
| Remove Word, Replace Word, Replace Query. | Since there's no query, there are no words to remove or replace. |
| Filter/Boost Matching Attributes | Rules that filter and boost facets require users to type a attribute into the query. Since there's no query or facet in the condition, there's no filter for the rule to boost. |
These limitations only apply to **context-only** and **conditionless** rules.
Other rules can use the full range of consequences.
{/* vale Google.Headings = NO */}
## Visual Editor or Manual Editor
You can use the **Visual Editor** or **Manual Editor** to create rules.
* **The Visual Editor** has the most visual way of configuring rules but doesn't offer all capabilities.
* **The Manual Editor** has more capabilities but is less visual.
Both editors use the [Rules API](/doc/libraries/sdk/methods/search/save-rules).
| Option | Capabilities |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Visual Editor** | • [Promote](/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/promote-hits) and [hide](/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/how-to-hide-hits) items
• Boost, bury, and filter [categories](/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-category-pages)
• Set priority on category ordering
• Ban categories of items
• [Merchandise](/doc/guides/managing-results/rules/merchandising-and-promoting) on filter selection
• Merchandise based on date range for time-limited promotions
• Merchandise based on geolocation, device, and user segment
• [Facet merchandising](/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets) (facet type and value reordering)
• [Display banners](/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/add-banners)
• Configurable preview UI |
| **Manual Editor** | • Merchandise on filter selection
• Add custom data to rules
• Display advanced banners |
| **Rules API** | • Explore the Rules API
• Build a custom merchandising UI |
## Rule tags
Create and manage rule tags in the [Algolia dashboard](https://dashboard.algolia.com/rules) or Merchandising Studio.
On the **Rules** page, click **Manage tags**.
A rule tag includes:
| Attribute | Required | Description |
| ----------- | -------- | ----------------------------------------- |
| Name | Yes | Unique within the index. |
| Description | No | Describes the tag's purpose. |
| Color | No | Color shown for the tag in the dashboard. |
By default, indices may contain up to 100 rule tags.
After you create a rule tag, you can add it to individual rules in the **Visual Editor** and **Manual Editor**.