Clear dictionary entries

Required API Key: any key with the editSettings ACL

Method signature

$client->clearDictionaryEntries(
  string dictionary
);

client.clear_dictionary_entries(
  string dictionary
)

client.clearDictionaryEntries(
  dictionary: DictionaryName,
  requestOptions: RequestOptions
)

client.clear_dictionary_entries(
  string dictionary,
  # + any requestOptions
)

client.clearDictionaryEntries<Dictionary: CustomDictionary>(
  in dictionary: Dictionary.Type,
  requestOptions: RequestOptions? = nil
)

client.clearDictionaryEntries(
    dictionary: Dictionary<T>,
    requestOptions: RequestOptions? = null
)

DictionaryClient.ClearDictionaryEntries(
  AlgoliaDictionary algoliaDictionary,
  RequestOptions requestOptions
);

client.clearDictionaryEntries(
  Dictionary dictionary,
  RequestOptions requestOptions
)

client.ClearDictionaryEntries(
  dictionaryName DictionaryName,
  opts ...interface{}
)

clear dictionary dictionary

See code examples

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.

About this method

Remove all words from a custom dictionary.

Examples

Read the Algolia CLI documentation for more information.

Clear stopword entries

Copy

1
$client->clearDictionaryEntries('stopwords');

1
2
3
4
5
6
7
8
9
10
11
AlgoliaDictionary algoliaDictionary = new AlgoliaDictionary
{
  Name = AlgoliaDictionaryType.Stopwords
};

// Synchronous
dictionaryClient.ClearDictionaryEntries(algoliaDictionary);

// Asynchronous
var clearDictionaryResponse = dictionaryClient.ClearDictionaryEntriesAsync(algoliaDictionary);
clearDictionaryResponse.Wait();

Parameters

Parameter	Description
`dictionary`	type: string Required Type of the dictionary entries you want to clear. Can be either `stopword`, `plural` or `compound`
`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. 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

Copy

          {
  "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?