API Reference / API Methods / Dictionaries / Set dictionary settings

Aug. 16, 2022

Set Dictionary Settings

Required API Key: any key with the editSettings ACL

Method signature

$client->setDictionarySettings(array(
  'disableStandardEntries' => array disableStandardEntries
));

client.set_dictionary_settings({
  disableStandardEntries: Hash disableStandardEntries
})

client.setDictionarySettings(
  dictionarySettings: DictionarySettings,
  requestOptions: RequestOptions
)

client.set_dictionary_settings(
 { 'disableStandardEntries': dict disableStandardEntries},
 # + any requestOptions
)

client.setDictionarySettings(
  settings: DictionarySettings,
  requestOptions: RequestOptions? = nil
)

client.setDictionarySettings(
    dictionarySettings: DictionarySettings,
    requestOptions: RequestOptions? = null
)

DictionaryClient.SetDictionarySettings(
  AlgoliaDictionarySettings algoliaDictionarySettings,
  RequestOptions requestOptions
);

client.setDictionarySettings(
  DictionarySettings dictionarySettings,
  RequestOptions requestOptions
)

client.SetDictionarySettings(
  settings DictionarySettings,
  opts ...interface{}
)

set dictionarySettings settings

See code examples

About this method

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

Enable or disable the use of standard dictionary entries

Examples

Read the Algolia CLI documentation for more information.

Set stopword settings

Copy

1
2
3
4
5
6
7
$client->setDictionarySettings(array(
  'disableStandardEntries' => array(
    'stopwords' => array(
      'en' => true
    )
  )
));

1
2
3
4
5
6
7
let settings = DictionarySettings(disableStandardEntries: .init(stopwords: [.english: true]))

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

1
2
3
4
5
6
val settings = DictionarySettings(
    disableStandardEntries = DisableStandardEntries(
        stopwords = mapOf(Language.English to true)
    )
)
client.setDictionarySettings(settings)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
DictionarySettings dictionarySettings = new DictionarySettings()
{
  DisableStandardEntries = new DisableStandardEntries()
  {
    StopWords = new Dictionary() { "en", true }
  }
};

// Synchronous
dictionaryClient.SetDictionarySettings(dictionarySettings);

// Asynchronous
var setDictionarySettingsResponse = await dictionaryClient.SetDictionarySettingsAsync(dictionarySettings);
setDictionarySettingsResponse.Wait()

1
2
3
4
5
6
7
8
DictionarySettings settings =
    new DictionarySettings()
        .setDisableStandardEntries(
            new DisableStandardEntries().setStopwords(Collections.singletonMap("en", true)));
// Synchronous
client.setDictionarySettings(settings);
// Asynchronous
client.setDictionarySettingsAsync(settings);

1
2
3
4
5
settings = search.DictionarySettings{
  DisableStandardEntries: opt.DisableStandardEntries(map[string]map[string]bool{"stopwords": {"en": true}),
}

res, err := client.SetDictionarySettings(settings)

1
2
3
4
5
6
7
8
9
10
11
val settings = DictionarySettings(
  Some(
    DisableStandardEntries(
      stopwords = Some(Map("en" -> true))
    )
  )
)

client.execute {
  set dictionarySettings settings
}

Reset stopword settings

Copy

1
2
3
4
5
$client->setDictionarySettings(array(
  'disableStandardEntries' => array(
    'stopwords' => null
  )
));

1
2
3
4
5
6
7
let settings = DictionarySettings(disableStandardEntries: .none)

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

1
2
3
4
5
6
val settings = DictionarySettings(
    disableStandardEntries = DisableStandardEntries(
        stopwords = null
    )
)
client.setDictionarySettings(settings)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
DictionarySettings dictionarySettings = new DictionarySettings()
{
  DisableStandardEntries = new DisableStandardEntries()
  {
    StopWords = null
  }
};

// Synchronous
dictionaryClient.SetDictionarySettings(dictionarySettings);

// Asynchronous
var setDictionarySettingsResponse = await dictionaryClient.SetDictionarySettingsAsync(dictionarySettings);
setDictionarySettingsResponse.Wait()

1
2
3
4
5
6
7
DictionarySettings settings =
    new DictionarySettings()
        .setDisableStandardEntries(new DisableStandardEntries().setStopwords(null));
// Synchronous
client.setDictionarySettings(settings);
// Asynchronous
client.setDictionarySettingsAsync(settings);

1
2
3
4
5
settings = search.DictionarySettings{
  DisableStandardEntries: opt.DisableStandardEntries(map[string]map[string]bool{"stopwords": nil}),
}

res, err := client.SetDictionarySettings(settings)

1
2
3
4
5
6
7
8
9
10
11
val settings = DictionarySettings(
  Some(
    DisableStandardEntries(
      stopwords = None
    )
  )
)

client.execute {
  set dictionarySettings settings
}

Parameters


            settings

type: object

Required

Map of language ISO codes supported by the dictionary (for example, “de” for German) to a boolean value. When set to true, the standard entries for the language are disabled.

"disableStandardEntries": {
  "stopwords": {
    "ru": "true",
    "en": "true",
    // ...
  }
}


            requestOptions

type: key-value mapping

default: No request options

Optional

A mapping of requestOptions to send along with the request.

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

Copy

          {
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}

        

`updatedAt`	string Date at which the indexing job has been created.
`taskID`	integer The taskID used with the waitTask method.

Did you find this page helpful?