API Reference / API Methods / Query rules / Search rules

Feb. 26, 2019

Search Rules

Required API Key: any key with the settings ACL

Method signature

$index->searchRules(string query)

$index->searchRules(string query, [
  // All the following parameters are optional
  'anchoring' => string,
  'context' => string,
  'page' => integer,
  'hitsPerPage' => integer,
  'enabled' => boolean
])

index.search_rules(
  string query,
  {
    anchoring: String,
    context: String,
    page: Integer,
    hitsPerPage: Integer,
    enabled: Boolean
  }
)

index.searchRules(
  {
    query: string,
    anchoring: string,
    context: string,
    page: integer,
    hitsPerPage: integer,
    enabled: boolean
  },
  callback
)

index.search_rules(str query, {
    // All the following parameters are optional
    'anchoring': str,
    'context': str,
    'page': int,
    'hitsPerPage': int,
    'enabled': bool
})

This method is not available in mobile API clients.

Query Rules need to be configured via
the Algolia Dashboard or with one of our backend API clients.

suspend fun Index.searchRules(
  query: RuleQuery = RuleQuery(),
  requestOptions: RequestOptions? = null
): ResponseSearchRules

@Serializable
data class RuleQuery(
    var query: String? = null,
    var anchoring: Anchoring? = null,
    var context: String? = null,
    var page: Int? = null,
    var hitsPerPage: Int? = null,
    var enabled: Boolean? = null
)

This method is not available in mobile API clients.

Query Rules need to be configured via
the Algolia Dashboard or with one of our backend API clients.

index.SearchRules(
  new RuleQuery
  {
    Query = String,
    Anchoring = String,
    Context = String,
    Page = int,
    HitsPerPage = int,
    Enabled = bool,
  })

index.searchRules(
  new RuleQuery(String query)
    .setAnchoring(String anchoring)
    .setContext(String context)
    .setPage(int page)
    .setHitsPerPage(int hitsPerPage)
    .setEnabled(bool enabled)
)

index.SearchRules(string query)
index.SearchRules(
  string query,
  opt.Anchoring(string anchoring),
  opt.RuleContexts(string context),
  opt.Page(int page),
  opt.HitsPerPage(int hitsPerPage),
  opt.EnableRules(bool enabled),
)

search.rules(in).index("indexName").query(
  QueryRules(
    query = String,
    anchoring = String,
    context = String,
    page = int,
    hitsPerPage = int,
    enabled = bool,
  )
)

See code examples

About this method

Search for rules matching various criteria.

Examples

Copy

$response = $index->searchRules('something', [
  'enabled' => true
]);

index.SearchRules( new RuleQuery("query")
  {
    Anchoring = "is",
    Context = "something",
    Page = 1,
    HitsPerPage = 10
  }
);

// Asynchronous
await index.SearchRulesAsync( new RuleQuery("query")
  {
    Anchoring = "is",
    Context = "something",
    Page = 1,
    HitsPerPage = 10
  }
);

// Sync
SearchResult<Rule> results = index.searchRules(
  new RuleQuery("something")
);

// Async
CompletableFuture<SearchResult<Rule>> results = index.searchRulesAsync(
  new RuleQuery("something")
);

Parameters

`query`	type: string default: "" Optional Full text query.
`anchoring`	type: string\|enum default: all anchoring Optional When specified, restricts matches to rules with a specific anchoring type. When omitted, all anchoring types may match. One of the following values: `is`, `startsWith`, `endsWith`, `contains`
`context`	type: string default: Any context Optional Restricts matches to contextual rules with a specific context (exact match).
`page`	type: integer default: 0 Optional Requested page (zero-based).
`hitsPerPage`	type: integer default: 20 Optional Maximum number of hits in a page. Minimum is 1, maximum is 1000.
`enabled`	type: boolean default: none Optional When specified, restricts matches to rules with a specific `enabled` status. When absent (default), all rules are retrieved, regardless of their `enabled` status.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

Copy
{
  "hits":[
    {
      "condition":{
        "pattern":"smartphone",
        "anchoring":"contains"
      },
      "consequence":{
        "params":{
          "filters":"category = 1"
        }
      },
      "objectID":"a-rule-id",
      "_highlightResult":{
        "condition":{
          "pattern":{
            "value":"<b>s<\/b>martphone",
            "matchLevel":"full",
            "fullyHighlighted":false,
            "matchedWords":[
              "s"
            ]
          },
          "anchoring":{
            "value":"contains",
            "matchLevel":"none",
            "matchedWords":[

            ]
          }
        },
        "consequence":{
          "params":{
            "filters":{
              "value":"category = 1",
              "matchLevel":"none",
              "matchedWords":[

              ]
            }
          }
        }
      }
    }
  ],
  "nbHits":1,
  "page":0,
  "nbPages":1
}

`hits`	list of rule Rule objects matched by the search query (see Rule Schema). Highlighting is provided through the standard mechanism (`_highlightResult` attribute inside every returned object)
`nbHits`	integer Total number of rules matching the query.
`page`	integer Returned page number (zero-based).
`nbPages`	integer Total number of pages.

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

Search Rules

About this method

Examples

Parameters

Response

JSON format

Did you find this page helpful?

On this page