API Reference / Crawler Configuration API / initialIndexSettings

initialIndexSettings

Type: Object
Parameter syntax
initialIndexSettings: {
   yourIndexName: {
     yourIndexSettings...
   }
}

About this parameter

Defines the settings for the indices that the crawler updates.

Index names should be provided as keys. Their values are objects that define Algolia index settings as properties (e.g. searchableAttributes attributesForFaceting).

Index settings will only be applied on your Algolia index during the first run or when the index is created. Once an index has been created, settings are not re-applied: this prevents you from overriding any manual changes that you made in the meantime.

Examples

1
2
3
4
5
6
7
8
9
10
{
  initialIndexSettings: {
    myIndexName: {
      searchableAttributes: ['title'],
    },
    mySecondIndexName: {
      searchableAttributes: ['title'],
    }
  }
}

Parameters

settings

A list of indexName to setting pairings.

settings ➔ setting

setting

A mapping of settings parameters you want to assign to your crawler with the specified index name.

Did you find this page helpful?