API client / Methods / Dictionaries

Save dictionary entries

Required API Key: any key with the editSettings ACL
Method signature
$client->saveDictionaryEntries(
  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.

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.

Send a batch of entries to a dictionary.

Examples

Read the Algolia CLI documentation for more information.

Save stopword entries

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

Save plural entries

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

Save compound entries

1
2
3
4
5
6
7
8
9
$client->saveDictionaryEntries(
  '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 save. 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 stop word you want to add or update. If the entry already exists in the standard dictionary provided by Algolia, you can override its behavior by adding it to the custom dictionary and setting its state to disabled.

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. If the entry already exists in the standard dictionary provided by Algolia, you can override its behavior by adding it to the custom dictionary and setting its state to disabled.

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?