API Reference / API Methods / Dictionaries / Replace dictionary entries

Replace Dictionary Entries

Required API Key: any key with the editSettings ACL
Method signature
$client->replaceDictionaryEntries(
  string dictionary,
  array  dictionaryEntries
);

About this method #

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

Replace a batch of dictionary entries.

Examples #

Replace stopword entries#

1
2
3
4
5
6
7
8
$client->replaceDictionaryEntries(
  'stopwords',
  array(array(
    'objectID' => 'down',
    'language' => 'en',
    'word' => 'down'
  ))
);

Replace plural entries#

1
2
3
4
5
6
7
8
$client->replaceDictionaryEntries(
  'plurals',
  array(array(
    'objectID' => 'chevaux',
    'language' => 'fr',
    'words' => array('cheval', 'chevaux')
  ))
);

Replace compound entries#

1
2
3
4
5
6
7
8
9
$client->replaceDictionaryEntries(
  'compounds',
  array(array(
    'objectID' => 'kopfschmerztablette',
    'language' => 'de',
    'word' => 'kopfschmerztablette',
    'decomposition' => array('kopf', 'schmerz', 'tablette')
  ))
);

Parameters #

dictionary #
type: string
Required

Type of the dictionary entries you want to replace. Can be either stopword, plural or compound

dictionaryEntries #
Required

An array of dictionary entries. Can contain either a list of stopwordEntry, pluralEntry or compoundEntry.

requestOptions #
type: key-value mapping
default: No request options
Optional

A mapping of requestOptions to send along with the request.

dictionaryEntry ➔ stopwordEntry #

objectID #
type: string
Required

Unique identifier of the entry to add or override.

language #
type: string
Required

Language ISO code supported by the dictionary (for example “en” for English).

word #
type: string
Required

The stopword you want to add or update. When word already exists in the standard dictionary provided by Algolia, the entry can be overridden by the one provided by the user.

state #
type: string
default: enabled
Optional

The state of the entry:

  • enabled: enable the current stopword

  • disabled: disable the current stopword

dictionaryEntry ➔ pluralEntry #

objectID #
type: string
Required

Unique identifier of the entry to add or override.

language #
type: string
Required

Language ISO code supported by the dictionary (for example “en” for English).

words #
type: string
Required

List of word declensions. The entry overrides existing entries when any of these words exist in the standard dictionary provided by Algolia.

dictionaryEntry ➔ compoundEntry #

objectID #
type: string
Required

Unique identifier of the entry to add or override.

language #
type: string
Required

Language ISO code supported by the dictionary (for example de for German).

word #
type: string
Required
  • When decomposition is empty: adds word as a compound atom. For example, atom “kino” decomposes the query “kopfkino” into “kopf” and “kino”.

  • When decomposition isn’t empty: creates a decomposition exception.

    For example, when decomposition is set to ["hund", "hutte"]exception “hundehutte” decomposes the word into “hund” and “hutte”, discarding the linking morpheme “e”.

decomposition #
type: string array
Required
  • When empty, the key word is considered as a compound atom.
  • Otherwise, it’s the decomposition of word.

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#

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?
PHP v3