Delete Dictionary Entries

Required API Key: any key with the editSettings ACL

Method signature

$client->deleteDictionaryEntries(
  string dictionary,
  array  objectIDs
);

client.delete_dictionary_entries(
  string dictionary,
  array  objectIDs
)

client.deleteDictionaryEntries(
  dictionary: DictionaryName,
  objectIDs: string[],
  requestOptions: RequestOptions
)

client.delete_dictionary_entries(
  string dictionary,
  array  objectIDs,
  # + any requestOptions
)

client.deleteDictionaryEntries<Dictionary: CustomDictionary>(
  from dictionary: Dictionary.Type,
  withObjectIDs objectIDs: [ObjectID]),
  requestOptions: RequestOptions? = nil
}

client.deleteDictionaryEntries(
    dictionary: Dictionary<T>,
    objectIDs: List<ObjectID>,
    requestOptions: RequestOptions? = null,
)

DictionaryClient.DeleteDictionaryEntries(
  AlgoliaDictionary algoliaDictionary,
  List<String> objectsIDs,
  RequestOptions requestOptions
);

client.deleteDictionaryEntries(
  Dictionary dictionary,
  List<String> objectIDs,
  RequestOptions requestOptions
)

client.DeleteDictionaryEntries(
  dictionaryName DictionaryName,
  objectIDs []string,
  opts ...interface{}
)

delete dictionary dictionary objectIDs objectIDs

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.

Delete a batch of dictionary entries.

Examples

Read the Algolia CLI documentation for more information.

Delete stopword entries

Copy

1
2
3
4
$client->deleteDictionaryEntries(
  'stopwords',
  array('down',' up', ...)
);

1
2
3
4
5
client.deleteDictionaryEntries(from: StopwordsDictionary.self, withObjectIDs: ["down", "up"]) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
val objectID = ObjectID("MyObjectID")
client.deleteDictionaryEntries(Dictionary.Stopwords, listOf(objectID))
// or using extension function:
client.deleteStopwordEntries(listOf(objectID))

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

// Synchronous
dictionaryClient.DeleteDictionaryEntries(algoliaDictionary, new List<String>() { "down", "up" });

// Asynchronous
var deleteDictionaryResponse = dictionaryClient.DeleteDictionaryEntriesAsync(algoliaDictionary, new List<String>() { "down", "up" });
deleteDictionaryResponse.Wait();

1
2
3
4
// Synchronous
client.deleteDictionaryEntries(Dictionary.STOPWORDS, Arrays.asList("down", "up"));
// Asynchronous
client.deleteDictionaryEntriesAsync(Dictionary.STOPWORDS, Arrays.asList("down", "up"));

Parameters

`dictionary`	type: string Required Type of the dictionary entries you want to delete. Can be either `stopword`, `plural` or `compound`
`objectIDs`	type: array Optional An array of dictionary entries `objectID`.
`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

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