Set dictionary settings

Turn standard dictionary entries on or off.

This page documents an earlier version of the API client. For the latest version, see Update dictionary settings.

Required ACL: editSettings

Examples

Set stopword settings

C#

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()

Reset stopword settings

C#

DictionarySettings dictionarySettings = new DictionarySettings()
{
  DisableStandardEntries = new DisableStandardEntries()
  {
    StopWords = null
  }
};

// Synchronous
dictionaryClient.SetDictionarySettings(dictionarySettings);

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

Parameters

settings · 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.

Example:

JSON

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

requestOptions · object

A mapping of request options to send along with the request.

Response

taskID · integer

The task ID used with the waitTask method.

updatedAt · string

Date at which the indexing job has been created.

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

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