API Reference / API Methods / Dictionaries / Search dictionary entries

Search Dictionary Entries

Required API Key: any key with the settings ACL
Method signature
$client->searchDictionaryEntries(
  string dictionary,
  string query,
  // any params and/or requestOptions
);

About this method

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.

Search for entries in a dictionary.

Examples

Search stop word entries

1
2
3
4
$client->searchDictionaryEntries('stopwords', 'und');
$client->searchDictionaryEntries('stopwords', 'und',
  array('language' => 'de')
);

Parameters

dictionary
type: string
Required

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

query
type: string
Required

The term to search for in the dictionary.

params

Key-value mapping with specific dictionary_search_parameter.

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

A mapping of requestOptions to send along with the request.

dictionary_search_parameter

page
type: integer
default: 0
Optional

Page of search results to fetch.

hitsPerPage
type: integer
default: 0
Optional

Number of hits retrieved per page of search results. Accepted range: [1, 1000].

language
type: string
Optional

The language ISO code of the dictionary (for example “de” for German).

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
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "hits": [
    {
      "objectID": "under",
      "language": "en",
      "word": "under",
      "type": "custom"
      "state": "enabled"
    },
    {
      // ...
    }
  ],
  "nbHits": 2,
  "page": 0
  "nbPages": 1
}
hits

An array of dictionary entries. Can contain either a list of stopword_entry, plural_entry or compound_entry.

nbHits
integer

Number of entries matching the query.

page
integer

Returned page number (zero-based) of paginated search results.

nbPages
integer

Total number of pages.

dictionary_entry ➔ stopword_entry

objectID
string

Unique identifier of the stop word.

language
string

The language ISO code of the dictionary (for example “de” for German).

word
string

The stop word 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
string

The state of a stop word’s dictionary entry: enabledor disabled.

type
string

Set to “standard” if the entry is in the default Algolia stop words dictionary. Otherwise, set to “custom”.

dictionary_entry ➔ plural_entry

objectID
string

Unique identifier of the plural word.

language
string

The language ISO code of the dictionary (for example “de” for German).

words
string
Required

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

type
string

Set to “standard” if the entry is in the default Algolia plurals dictionary. Otherwise, set to “custom”.

dictionary_entry ➔ compound_entry

objectID
string

Unique identifier of the compound word entry.

language
string

The language ISO code of the dictionary (for example “de” for German).

word
string
  • 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
string array
  • When empty, the key word is considered as a compound atom.
  • Otherwise, it’s the decomposition of word.
type
string

Set to “standard” if the entry is in the default Algolia compound words dictionary. Otherwise, set to “custom”.

Did you find this page helpful?