API Reference / API Parameters / restrictSearchableAttributes

Jan. 14, 2021

restrictSearchableAttributes

Type: list of strings

Engine default: all attributes in searchableAttributes

Parameter syntax

'restrictSearchableAttributes' => [
  'attribute'
]

restrictSearchableAttributes: [
  'attribute'
]

restrictSearchableAttributes: [
  'attribute'
]

'restrictSearchableAttributes': [
  'attribute'
]

restrictSearchableAttributes = [
  "attribute"
]

restrictSearchableAttributes {
    +"attribute"
    +...
}

.setRestrictSearchableAttributes(
  "attribute"
)

.RestrictSearchableAttributes(
    new List<string>{ "attribute" }
)

.setRestrictSearchableAttributes(Arrays.asList(
  "attribute"
))

opt.RestrictSearchableAttributes(
  "attribute",
)

restrictSearchableAttributes = Some(Seq(
  "attribute"
))

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

See code examples

About this parameter

Restricts a given query to look in only a subset of your searchable attributes.

This setting overrides searchableAttributes for specific searches, without changing the priority order of the searchableAttributes.

Usage notes:

This setting is a search parameter, and only affects searches that specify it.
This setting only works when searchableAttributes isn’t empty or null.
You can’t use this setting on an attribute that’s part of a comma-separated list of attributes within searchableAttributes. For example, if your searchableAttributes parameter contains ['title, category', 'content'], title and category are part of one comma-separated element and have the same priority, while content has its own priority level. You can set restrictSearchableAttributes to ['content'], but you can’t set restrictSearchableAttributes to ['title'], ['category'], ['title, category'] or ['title', 'category'].
You can’t use this setting to change the priority order of searchableAttributes. For example, if your searchableAttributes parameter contains ['title', 'category', 'content'], and restrictSearchableAttributes parameter contains ['category', 'title'], the engine only searches in the category and title attributes. Matches in the title attribute still rank higher than matches in the category attribute.

Examples

Search on a restricted set of attributes

In this example, let’s consider that searchableAttributes contains ['title', 'author', 'publisher', 'content'], but we only want to search in title and author

Copy

1
2
3
4
5
6
$results = $index->search('query', [
  'restrictSearchableAttributes' => [
    'title',
    'author'
  ]
]);

1
2
3
4
5
6
7
8
9
10
11
let query = Query("query")
  .set(\.restrictSearchableAttributes, to: [
    "title",
    "author"
  ])

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

1
2
3
4
5
6
7
8
9
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    restrictSearchableAttributes = Some(Seq(
      "title",
      "author"
    ))
  )
}

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

restrictSearchableAttributes

About this parameter

Usage notes:

Examples

Search on a restricted set of attributes

Did you find this page helpful?

On this page