searchableAttributes

About this parameter

The complete list of attributes that will be used for searching.

This setting is critical to establishing good relevance, for 2 main reasons:

• Limits the scope of a search to the attributes listed in this setting. Defining specific attributes as searchable is critical for relevance because it gives you direct control over what information (i.e., attributes) the search engine will look at. Not every attribute in your index is useful for search; for example, some attributes contain URLs, others are used for display purposes only. Such attributes are not relevant to search. With this setting, you guide the engine to search only those attributes relevant to search.
• Creates an order of priority for every listed attribute that the engine uses to improve relevance. The order in which the attributes appear determine their search priority. The engine will start searching your index using the first attributes in the list. If it finds a sufficient number of records, it stops and returns the results. If it doesn’t find enough records, it will continue searching using the next set of attributes, and so on.

Usage notes:

• Default/Empty list: If you don’t use this setting, or use it with an empty list, the engine will search for all attributes.
• Same Priority: You can create the same priority by putting more than one attribute in the same string.
• Ordering: In addition to creating attribute-level priority, you can also determine how the engine is going to search within an attribute. The engine favors matches at the beginning of an attribute by default, but you can change it to ignore positioning and consider any match within an attribute of equal importance. See below.
• Nested attributes: When you specify an attribute that has children attributes, all of them will be indexed. If you don’t want the full nest to be searched, you can reference a child attribute, for example: categories.lvl0.child_attribute.sub_child_attribute

Modifier:

• unordered: There is no preference: any match anywhere in the attribute has the same weight.

  By default, searchable attributes are set as ordered: matches at the beginning of an attribute are more important than in the middle, and matches in the middle are more important than towards the end. Setting them as unordered cancels out this behavior.

  Note that you can’t set searchable attributes with same priority but only modifying some of them. You can’t have modified and unmodified searchable attributes on the same line (e.g., 'unordered(attribute1), attribute2' isn’t valid).

Examples

Set searchableAttributes

The following example shows how to:

• make some attributes searchable,
• put several attributes at the same level,
• set an attribute as unordered,
• search only a child attribute.

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
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
index.setSettings([
  "searchableAttributes": [
    "title,alternative_title",
    "author",
    "unordered(text)",
    "emails.personal"
  ]
])

1
2
3
4
5
6
7
8
9
10
index.setSettings(
  new JSONObject().put(
    "searchableAttributes",
    new JSONArray()
      .put("title,alternative_title")
      .put("author")
      .put("unordered(text)")
      .put("emails.personal")
  )
);

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")
    ))
  )
}

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

index.setSettings(settings)