API Reference / API Methods / Dictionaries / Clear dictionary entries

Clear Dictionary Entries

Required API Key:
Method signature
$client->clearDictionaryEntries(
  string dictionary
);

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.

Clear all entries in a given dictionary

Examples

Clear stopword entries

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

Parameters

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

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?