API Reference / API Methods / Dictionaries / Search dictionary entries

Aug. 16, 2022

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
);

client.search_dictionary_entries(
  string dictionary
  string query,
  # any params and/or requestOptions
)

client.searchDictionaryEntries(
  dictionary: DictionaryName,
  query: string,
  requestOptions: RequestOptions
)

client.search_dictionary_entries(
  string dictionary
  string query,
  # + any requestOptions
)

client.searchDictionaryEntries<Dictionary: CustomDictionary>(
  in dictionary: Dictionary.Type,
  query: DictionaryQuery // includes params,
  requestOptions: RequestOptions? = nil
)

client.searchDictionaryEntries(
    dictionary: Dictionary<T>,
    query: Query,
    requestOptions: RequestOptions? = null
)

dictionaryClient.SearchDictionaryEntries(
  AlgoliaDictionary algoliaDictionary,
  Query query,
  RequestOptions requestOptions
);

client.searchDictionaryEntries(
  Dictionary dictionary,
  Query query,
  RequestOptions requestOptions
)

client.SearchDictionaryEntries(
  dictionary DictionaryName,
  query string,
  opts ...interface{}
)

search into dictionary query query

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.

Search for entries in a dictionary.

Examples

Read the Algolia CLI documentation for more information.

Search stop word entries

Copy

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

1
2
3
4
5
6
7
8
let query = DictionaryQuery(query: "und")
  .set(\.language, to: .german)

client.searchDictionaryEntries(in: StopwordsDictionary.self, query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
val response = client.searchDictionaryEntries(
    dictionary = Dictionary.Stopwords,
    query = Query("und", queryLanguages = listOf(Language.Dutch)))
// or using extension function:
val response = client.searchStopwordEntries(
    query = Query("und", queryLanguages = listOf(Language.Dutch))
)

1
2
3
4
5
6
7
8
9
10
11
12
Query query = new Query("und") { QueryLanguages = new List<String>() { "de"} };

AlgoliaDictionary algoliaDictionary = new AlgoliaDictionary
{
  Name = AlgoliaDictionaryType.Stopwords
};

// Synchronous
DictionaryClient.SearchDictionaryEntries<String>(algoliaDictionary, query);

// Asynchronous
var SearchDictionaryResponse = await DictionaryClient.SearchDictionaryEntriesAsync<string>(algoliaDictionary, query);

1
2
3
4
5
Query query = new Query("und").setQueryLanguages(Collections.singletonList("de"));
// Synchronous
client.searchDictionaryEntries(Dictionary.STOPWORDS, query);
// Asynchronous
client.searchDictionaryEntriesAsync(Dictionary.STOPWORDS, query);

Parameters

`dictionary`	type: string Required Type of the dictionary entries you want to search: `stopwords` `plurals` `compounds`
`query`	type: string Required The term to search for in the dictionary.
`params`	type: dictionary_search_parameter Optional 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

Copy

          {
  "hits": [
    {
      "objectID": "under",
      "language": "en",
      "word": "under",
      "type": "custom"
    },
    {
      // ...
    }
  ],
  "nbHits": 2,
  "page": 0
  "nbPages": 1
}

        

`hits`	list of stopword_entry\|plural_entry\|compound_entry 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.
`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?