enableRules

Whether to turn off index rules

The enableRules parameter controls whether index rules are applied to the query.

Examples

Enable index rules for all queries

Current API clients

C#

var response = await client.SetSettingsAsync(
  "INDEX_NAME",
  new IndexSettings { EnableRules = true }
);

final response = await client.setSettings(
  indexName: "INDEX_NAME",
  indexSettings: IndexSettings(
    enableRules: true,
  ),
);

response, err := client.SetSettings(client.NewApiSetSettingsRequest(
  "INDEX_NAME",
  search.NewEmptyIndexSettings().SetEnableRules(true)))
if err != nil {
  // handle the eventual error
  panic(err)
}

UpdatedAtResponse response = client.setSettings("INDEX_NAME", new IndexSettings().setEnableRules(true));

const response = await client.setSettings({ indexName: 'theIndexName', indexSettings: { enableRules: true } });

var response =
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(enableRules = true),
  )

$response = $client->setSettings(
    'INDEX_NAME',
    ['enableRules' => true,
    ],
);

response = client.set_settings(
    index_name="INDEX_NAME",
    index_settings={
        "enableRules": True,
    },
)

response = client.set_settings("INDEX_NAME", Algolia::Search::IndexSettings.new(enable_rules: true))

val response = Await.result(
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(
      enableRules = Some(true)
    )
  ),
  Duration(100, "sec")
)

let response = try await client.setSettings(
    indexName: "INDEX_NAME",
    indexSettings: IndexSettings(enableRules: true)
)

Legacy API clients

PHP

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

index.set_settings(
  {
    enableRules: false
  }
)

index
  .setSettings({
    enableRules: false,
  })
  .then(() => {
    // done
  });

index.set_settings({"enableRules": False})

let settings = Settings()
  .set(\.enableRules, to: false)

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

val settings = settings {
    enableRules = false
}

index.setSettings(settings)

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

index.SetSettings(settings);

index.setSettings(
  new IndexSettings()
    .setEnableRules(false)
);

res, err := index.SetSettings(search.Settings{
	EnableRules: opt.EnableRules(false),
})

client.execute {
  setSettings of "myIndex" `with` IndexSettings(
    enableRules = Some(false)
  )
}

Turn on index rules for the current query

Current API clients

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "query", EnableRules = true })
);

final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "query",
    enableRules: true,
  ),
);

response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
  "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
  search.NewEmptySearchParamsObject().SetQuery("query").SetEnableRules(true))))
if err != nil {
  // handle the eventual error
  panic(err)
}

SearchResponse response = client.searchSingleIndex(
  "INDEX_NAME",
  new SearchParamsObject().setQuery("query").setEnableRules(true),
  Hit.class
);

const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'query', enableRules: true },
});

var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "query", enableRules = true),
  )

$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'query',
        'enableRules' => true,
    ],
);

response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "query",
        "enableRules": True,
    },
)

response = client.search_single_index(
  "INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "query", enable_rules: true)
)

val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("query"),
        enableRules = Some(true)
      )
    )
  ),
  Duration(100, "sec")
)

let response: SearchResponse<Hit> = try await client.searchSingleIndex(
    indexName: "INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
        query: "query",
        enableRules: true
    ))
)

Legacy API clients

C#

index.Search(new Query("")
{
    EnableRules = true
});

res, err := index.Search(
  "query",
  opt.EnableRules(true),
})

index.search(
  new Query("query")
    .setEnableRules(true)
);

index
  .search("query", {
    enableRules: true,
  })
  .then(({ hits }) => {
    console.log(hits);
  });

val query = query("query") {
    enableRules = true
}

index.search(query)

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

results = index.search("query", {"enableRules": True})

results = index.search(
  "query",
  {
    enableRules: true
  }
)

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    enableRules = Some(true)
  )
}

let query = Query("query")
  .set(\.enableRules, to: true)

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