Replace Dictionary Entries
$client->replaceDictionaryEntries( string dictionary, array dictionaryEntries );
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.
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 |
dictionaryEntries
|
type: list of stopwordEntry|pluralEntry|compoundEntry
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 |
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 |
state
|
type: string
default: enabled
Optional
The state of the entry:
|
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 |
word
|
type: string
Required
|
decomposition
|
type: string array
Required
|
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. |