attributesForFaceting

About this parameter

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

Use this setting for 2 reasons:

• to turn an attribute into a facet
• to make any string attribute filterable.

By default, your index comes with no categories. By designating an attribute as a facet, this enables Algolia to compute a set of possible values that can later be used to filter results or display these categories. You can also get a count of records that match those values.

Usage notes

• This setting enables both faceting and filtering.

  • Faceting allows you to use attributes inside facets
  • Filtering allows you to use attributes inside filters, facetFilters and optionalFilter

• Default: If not specified or empty, no attribute will be faceted.

• Nested Attributes: All attributes can be used for faceting, even when nested. For example, authors.mainAuthor can be used for faceting. Here the faceting will be applied only on mainAuthor.

You should not include colons (:) in attribute names that you want to use for faceting, because the filters syntax relies on that character as a delimiter.

Modifiers:

• filterOnly: Defines an attribute as filterable only and not facetable.

  If you only need the filtering feature, you can take advantage of filterOnly which will reduce the index size and improve the speed of the search.

  You cannot define an attribute as both ‘filterOnly’ and ‘searchable’. The following therefore is not doable: filterOnly(searchable(attributeName)).

• searchable: Defines an attribute as searchable.

  If you want to search for values of a given facet (using the Search for facet values method) you need to specify searchable.

  You cannot define an attribute as both ‘searchable’ and ‘filterOnly’. The following therefore is not doable: searchable(filterOnly(attributeName)).

Examples

Set attributesForFaceting

The following example shows how to:

• make some attributes usable for faceting
• make an attribute only filterable
• make an attribute usable with Search for facet values

1
2
3
4
5
6
7
$index->setSettings([
  'attributesForFaceting' => [
    "author",
    "filterOnly(category)",
    "searchable(publisher)"
  ]
]);

1
2
3
4
5
6
7
index.set_settings({
  attributesForFaceting: [
    'author',
    'filterOnly(category)',
    'searchable(publisher)'
  ]
})

1
2
3
4
5
6
7
8
9
index.setSettings({
  attributesForFaceting: [
    'author',
    'filterOnly(category)',
    'searchable(publisher)'
  ]
}).then(() => {
  // done
});

1
2
3
4
5
6
7
index.set_settings({
    'attributesForFaceting': [
        'author',
        'filterOnly(category)',
        'searchable(publisher)'
    ]
})

1
2
3
4
5
6
7
8
9
10
11
12
let settings = Settings()
  .set(\.attributesForFaceting, to: [
    "author",
    .filterOnly("category"),
    .searchable("publisher")
  ])

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

1
2
3
4
5
IndexSettings settings = new IndexSettings
{
  AttributesForFaceting = new List<string>
      {"author", "filterOnly(category)", "searchable(publisher)"}
};

1
2
3
4
5
6
7
index.setSettings(
  new IndexSettings().setAttributesForFaceting(Arrays.asList(
    "author",
    "filterOnly(category)",
    "searchable(publisher)"
  ))
);

1
2
3
4
5
6
7
res, err := index.SetSettings(search.Settings{
  AttributesForFaceting: opt.AttributesForFaceting(
    "author",
    "filterOnly(category)",
    "searchable(publisher)",
  ),
})

1
2
3
4
5
6
7
8
9
client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    attributesForFaceting = Some(Seq(
      "author",
      "filterOnly(category)",
      "searchable(publisher)",
    ))
  )
}

1
2
3
4
5
6
7
8
9
val settings = settings {
    attributesForFaceting {
        +"author"
        +FilterOnly("category")
        +Searchable("publisher")
    }
}

index.setSettings(settings)