unretrievableAttributes

Type: list of strings

Engine default: [] (no attribute is unretrievable)

Parameter syntax

'unretrievableAttributes' => [
  'attribute'
]

unretrievableAttributes: [
  'attribute'
]

unretrievableAttributes: [
  'attribute'
]

'unretrievableAttributes': [
  'attribute'
]

unretrievableAttributes = [
  "attribute"
]

unretrieveableAttributes {
    +"attribute"
    +...
}

IndexSettings settings = new IndexSettings
{
  UnretrievableAttributes = new List<string> { "attribute" }
};

new IndexSettings().setUnretrievableAttributes(Arrays.asList(
  "attribute"
))

opt.UnretrievableAttributes(
  "attribute",
)

unretrievableAttributes = Some(Seq(
  "attribute"
))

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

See code examples

About this parameter

List of attributes you don’t want the engine to retrieve at query time.

Preventing particular attributes from being retrieved may be particularly important for security or business reasons. Some attributes may be helpful for ranking or other technical purposes but should never be seen by your users, for example, total sales, permissions, and other private information. This setting guarantees this.

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.

Usage notes

This setting is ignored if the query is authenticated with the admin API key.

Using the dashboard

You can also add and remove these unretrievable attributes from the dashboard: Indices > Configuration > Search behavior > Retrieved attributes.

Under Unretrievable attributes:

Click Add an Attribute to select and add an attribute to the list
Click the trash icon to remove an attribute from the list.

Examples

Make some attributes unretrievable

Copy

1
2
3
4
5
$index->setSettings([
  'unretrievableAttributes' => [
    'total_number_of_sales'
  ]
]);

1
2
3
4
5
6
7
8
9
10
let settings = Settings()
  .set(\.unretrievableAttributes, to: [
    "total_number_of_sales"
  ])

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