API client / Methods / Dictionaries

Set dictionary settings

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

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

About this method # A

Turn standard dictionary entries on or off.

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

Parameter Description
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. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format#

1
2
3
4
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
Field Description
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