🎉 Try the public beta of the new docs site at algolia.com/doc-beta! 🎉
API client / Methods / Dictionaries

Get dictionary settings

Required API Key: any key with the settings ACL
Method signature
$client->getDictionarySettings();

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

About this method # A

Retrieve the dictionary override settings for plurals, stop words, and compound words.

You can find the list of ‘languages` settings in the settings parameters page.

Examples # A

Get stopword settings#

1
$client->getDictionarySettings();

Parameters # A

Parameter Description
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
5
6
7
{
  "disableStandardEntries": {
    "stopwords": {
      "ru": "true"
    }
  }
}
Field Description
settings #
object

Map of language ISO code 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.

Fetch settings doesn’t return false values.

"disableStandardEntries": {
  "stopwords": {
    "ru": "true",
    "en": "true",
    // ...
  }
}
Did you find this page helpful?
PHP v3