API Reference / API Methods / Dictionaries / Set dictionary settings

Set Dictionary Settings

Required API Key: any key with the editSettings ACL
Method signature
$client->setDictionarySettings(array(
  'disableStandardEntries' => array disableStandardEntries
));

About this method # A

Enable or disable the use of standard dictionary entries

Examples # A

Set stopword settings#

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

Reset stopword settings#

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

Parameters # A

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 # A

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#

1
2
3
4
{
  "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?
PHP v3