API Reference / API Parameters / enableRules

Feb. 26, 2019

enableRules

Type: boolean

Engine default: true

Parameter syntax

'enableRules' => true|false

enableRules: true|false

enableRules: true|false

'enableRules': True|False

"enableRules": true|false

enableRules: Boolean = true|false

new JSONObject()
  .put("enableRules", true|false)

IndexSettings settings = new IndexSettings();
settings.EnableRules = true|false;

.setEnableRules(true|false)

opt.EnableRules(true|false)

enableRules = Some(true|false)

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, setSettingsAsync, browseAsync, searchForFacetValues Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Whether rules should be globally enabled.

This is a global switch that affects all rules.

Usage notes:

When true, rules processing is enabled: rules may match the query.
When false, rules processing is disabled: no rule will match the query.

Examples

Enable Rules by default

Copy

$index->setSettings([
  'enableRules' => true
]);

Enable rules for the current search

Copy

$results = $index->search('query', [
  'enableRules' => true
]);

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

enableRules

About this parameter

Usage notes:

Examples

Enable Rules by default

Enable rules for the current search

Did you find this page helpful?

On this page