Get Dictionary Settings

Required API Key: any key with the settings ACL

Method signature

$client->getDictionarySettings();

client.get_dictionary_settings

client.getDictionarySettings(
   requestOptions: RequestOptions_
 )

client.get_dictionary_settings(
  # + any requestOptions
)

client.getDictionarySettings(
  requestOptions: RequestOptions? = nil,
  completion: Result<DictionarySettings> -> Void
)

client.getDictionarySettings(
  requestOptions: RequestOptions? = null_
)

dictionaryClient.GetDictionarySettings(
  RequestOptions requestOptions
);

client.getDictionarySettings(
  RequestOptions requestOptions
)

client.GetDictionarySettings( opts _...interface{} )

get dictionarySettings

See code examples

About this method

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

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

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

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

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

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

Read the Algolia CLI documentation for more information.

Get stopword settings

Copy

1
$client->getDictionarySettings();

1
2
3
4
5
6
// Synchronous
dictionaryClient.GetDictionarySettings();

// Asynchronous
var getDictionarySettingsResponse = dictionaryClient.GetDictionarySettingsAsync();
getDictionarySettingsResponse.Wait();

Parameters


            requestOptions

type: key-value mapping

default: No request options

Optional

A mapping of requestOptions to send along with the request.

Response

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

Copy

          {
  "disableStandardEntries": {
    "stopwords": {
      "ru": "true"
    }
  }
}

        


          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?