API Reference / API Methods / Dictionaries / Set dictionary settings

Set Dictionary Settings

Required API Key:
Method signature
$client->setDictionarySettings(array(
  'disableStandardEntries' => array disableStandardEntries
));

About this method

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

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

Set dictionary settings.

Examples

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

settings
type: object
Required

Map of language ISO code supported by the dictionary (for example, “en” for English) 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

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

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?