searchableAttributes

About this parameter

The complete list of attributes used for searching.

This setting is crucial for two reasons:

• It narrows the search area to specific attributes. By selecting which attributes can be searched, you control what the search engine looks at. Avoid including attributes that don’t help with searching, such as URLs or images. For more information, see Searchable attributes.

• It sets a priority order for the attributes. The position of attributes in the list of searchableAttributes determines their priority in the search. Records matching higher-priority attributes score better than those matching lower-priority attributes.

Updating the searchableAttributes parameter rebuilds your index. If you need near real-time indexing, avoid changing the index configuration during high-traffic times.

Usage notes

Default

By default, or if you set searchableAttributes to an empty list, Algolia searches in all attributes. This turns off the Attributes ranking criterion.

Order

To determine how Algolia searches within an attribute, use modifiers. 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.

Attributes with the same priority

To make two attributes equally important, include them in the same comma-separated string. Attributes with the same priority as others are always unordered.

Nested attributes

When you specify an attribute with nested attributes, Algolia indexes them all. If you don’t want to search the entire nested attribute, you can reference a child attribute, such as categories.lvl0.child_attribute.sub_child_attribute.

There’s no limit to the number of attributes in the list, but having many attributes slows down calls to getSettings. This can make the Algolia dashboard slower and less responsive.

Modifiers

Examples

In this example, Algolia searches for matches in the title, alternativeTitle, author, text, and email.personal attributes. Matches in the title attribute rank higher than matches in the author attribute. Matches in the title and alternativeTitle attributes rank equally. Matches at the start of an attribute rank higher, except in the text attribute, where all matches rank equally. The email attribute is nested, but only the personal child attribute is searchable.

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
index.set_settings({
  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")
    ))
  )
}