Set dictionary settings

Turn standard dictionary entries on or off.

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

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

res, err := client.SetDictionarySettings(settings)

DictionarySettings settings =
    new DictionarySettings()
        .setDisableStandardEntries(
            new DisableStandardEntries().setStopwords(Collections.singletonMap("en", true)));
// Synchronous
client.setDictionarySettings(settings);
// Asynchronous
client.setDictionarySettingsAsync(settings);

client.setDictionarySettings({
  disableStandardEntries: {
    stopwords: {
      en: true,
    },
  },
});

val settings = DictionarySettings(
    disableStandardEntries = DisableStandardEntries(
        stopwords = mapOf(Language.English to true)
    )
)
client.setDictionarySettings(settings)

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

client.set_dictionary_settings({
  'disableStandardEntries': {
    'stopwords': { 'en': True }
  }
})

client.set_dictionary_settings({
  disableStandardEntries: {
    stopwords: {
      en: true
    }
  }
})

val settings = DictionarySettings(
  Some(
    DisableStandardEntries(
      stopwords = Some(Map("en" -> true))
    )
  )
)

client.execute {
  set dictionarySettings settings
}

let settings = DictionarySettings(disableStandardEntries: .init(stopwords: [.english: true]))

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

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

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

res, err := client.SetDictionarySettings(settings)

DictionarySettings settings =
    new DictionarySettings()
        .setDisableStandardEntries(new DisableStandardEntries().setStopwords(null));
// Synchronous
client.setDictionarySettings(settings);
// Asynchronous
client.setDictionarySettingsAsync(settings);

client.setDictionarySettings({
  disableStandardEntries: {
    stopwords: null
  },
});

val settings = DictionarySettings(
    disableStandardEntries = DisableStandardEntries(
        stopwords = null
    )
)
client.setDictionarySettings(settings)

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

client.set_dictionary_settings({
  'disableStandardEntries': {
    'stopwords': None
  }
})

client.set_dictionary_settings({
  disableStandardEntries: {
    stopwords: nil
  }
})

val settings = DictionarySettings(
  Some(
    DisableStandardEntries(
      stopwords = None
    )
  )
)

client.execute {
  set dictionarySettings settings
}

let settings = DictionarySettings(disableStandardEntries: .none)

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

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
}