searchableAttributes

Type: list of strings

Engine default: [] (all string attributes)

Formerly: attributesToIndex

Parameter syntax

'searchableAttributes' => [
  'attribute1',
  'attribute2, attribute3', // both attributes have the same priority
  'unordered(attribute4)'
]

searchableAttributes: [
  'attribute1',
  'attribute2, attribute3', # both attributes have the same priority
  'unordered(attribute4)'
]

searchableAttributes: [
  'attribute1',
  'attribute2, attribute3', // both attributes have the same priority
  'unordered(attribute4)'
]

'searchableAttributes': [
  'attribute1',
  'attribute2, attribute3', # both attributes have the same priority
  'unordered(attribute4)'
]

searchableAttributes = [
  "attribute1",
  "attribute2, attribute3", // both attributes have the same priority
  .unordered("attribute4"),
]

searchableAttributes {
    +"attribute1"
    +"attribute2, attribute3" // both attributes have the same priority
    +Unordered("attribute4")
}

IndexSettings settings = new IndexSettings
{
    SearchableAttributes = new List<string>
        {
          "attribute1",
          "attribute2, attribute3", # both attributes have the same priority
          "unordered(attribute4)"
        },
};

new IndexSettings().setSearchableAttributes(Arrays.asList(
  "attribute1",
  "attribute2, attribute3", // both attributes have the same priority
  "unordered(attribute4)"
))

opt.SearchableAttributes(
  "attribute1",
  "attribute2, attribute3", // both attributes have the same priority
  "unordered(attribute4)",
)

searchableAttributes = Some(Seq(
  SearchableAttributes.attribute("attribute1")
  SearchableAttributes.attributes("attribute2", "attribute3") // both attributes have the same priority
  SearchableAttributes.unordered("attribute4")
))

Can be used in these methods:
setSettings set_settings setSettings set_settings setSettings setSettings SetSettings setSettings SetSettings setSettings

See code examples

About this parameter

The complete list of attributes used for searching.

This setting is critical to establishing excellent relevance for two main reasons:

It limits the scope of a search to the listed attributes. Defining specific attributes as searchable gives you direct control over what information the search engine should look at. Some attributes contain URLs; others exist for display purposes only. Such attributes are not helpful for searching.
It creates a priority order between attributes that the engine uses to improve relevance. The order in which the attributes appear determines their search priority. Records with matches in the first attribute(s) of the list score higher on the attribute criterion than records with matches in the second attribute(s), which score higher than records with matches in the third attribute(s), and so on.

Whenever you change this parameter, the engine rebuilds your entire index. If you need to do near real-time indexing, try not to change the setting during your peak-traffic times.

Usage notes

Default/empty list: if you don’t use this setting, or use it with an empty list, the engine searches in all attributes.
Ordering: in addition to creating attribute-level priority, you can also determine how the engine searches within an attribute. By default, the engine favors matches at the beginning of an attribute, but you can change it to ignore positioning and consider any match within an attribute of equal importance.
Same priority: you can create the same priority for several attributes by setting them in the same comma-separated string. Attributes that are on the same priority as others are always unordered.
Nested attributes: when you specify an attribute with nested attributes, the engine indexes them all. If you don’t want to search the entire attribute, you can reference a child attribute (such as categories.lvl0.child_attribute.sub_child_attribute).

Modifiers

unordered

Any match anywhere in the attribute has the same weight.

By default, searchableAttributes added from the API are ordered, meaning that matches at the beginning of an attribute are more relevant than matches towards the end. Setting them as unordered makes all matches equal regardless of their position in the attribute.

If you add searchableAttributes through the dashboard, the UI defaults to setting your attribute as unordered (select ordered from the dropdown to change it).

If you set searchableAttributes with the same priority, they’re always unordered.

Examples

Copy

1
2
3
4
5
6
7
8
$index->setSettings([
  'searchableAttributes' => [
    'title,alternative_title',
    'author',
    'unordered(text)',
    'emails.personal'
  ]
]);

1
2
3
4
5
6
7
8
9
10
index.setSettings({
  searchableAttributes: [
    'title,alternative_title',
    'author',
    'unordered(text)',
    'emails.personal'
  ]
}).then(() => {
  // done
});

1
2
3
4
5
6
7
8
index.set_settings({
    'searchableAttributes': [
        'title,alternative_title',
        'author',
        'unordered(text)',
        'emails.personal'
    ]
})

1
2
3
4
5
6
7
8
9
10
11
12
13
let settings = Settings()
  .set(\.searchableAttributes, to: [
    "title,alternative_title",
    "author",
    .unordered("text"),
    "emails.personal"
  ])

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

1
2
3
4
5
6
7
8
9
10
val settings = settings {
    searchableAttributes {
        +"title,alternativeTitle"
        +"author"
        +Unordered("text")
        +"emails.personal"
    }
}

index.setSettings(settings)

1
2
3
4
5
6
7
8
9
10
11
12
IndexSettings settings = new IndexSettings
{
    SearchableAttributes = new List<string>
    {
      "title,alternative_title",
      "author",
      "unordered(text)",
      "emails.personal"
    }
};

index.SetSettings(settings);

1
2
3
4
5
6
7
8
index.setSettings(
  new IndexSettings().setSearchableAttributes(Arrays.asList(
    "title,alternative_title",
    "author",
    "unordered(text)",
    "emails.personal"
  ))
);

1
2
3
4
5
6
7
8
res, err := index.SetSettings(search.Settings{
  SearchableAttributes: opt.SearchableAttributes(
    "title,alternative_title",
    "author",
    "unordered(text)",
    "emails.personal",
  ),
})

1
2
3
4
5
6
7
8
9
10
client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    searchableAttributes = Some(Seq(
      SearchableAttributes.attributes("title", "alternative_title")
      SearchableAttributes.attribute("author")
      SearchableAttributes.unordered("text")
      SearchableAttributes.attribute("emails.personal")
    ))
  )
}

Did you find this page helpful?

searchableAttributes

About this parameter

Usage notes

Modifiers

Examples

On this page