Search dictionary entries

Search for entries in a dictionary.

Required ACL: settings

Examples

C#

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

res, err := client.SearchDictionaryEntries(search.Stopwords, "und")
res, err := client.SearchDictionaryEntries(search.Stopwords, "und", opt.Language("de"))

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

client.searchDictionaryEntries("stopwords", "und");
client.searchDictionaryEntries("stopwords", "und", { language: "de" });

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

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

client.search_dictionary_entries("stopwords", "und")
client.search_dictionary_entries("stopwords", "und", {language: "de"})

client.search_dictionary_entries("stopwords", "und")
client.search_dictionary_entries("stopwords", "und", {language: "de"})

client.execute {
  search into Stopwords query QueryDictionary(query = Some("und"), language = Some("de"))
}

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)")
  }
}

Parameters

dictionary · enum<string> · required

Dictionary type. One of: stopwords, plural, compounds.

query · string · required

The term to search for in the dictionary.

params · object

Additional parameters for searching.

Show child attributes

hitsPerPage · integer · default: 0

Number of hits retrieved per page of search results. From 1 to 1,000.

language · string

The language ISO code of the dictionary, for example de for German.

page · integer · default: 0

Page of search results to retrieve.

requestOptions · object

A mapping of request options to send along with the request.

Response

hits · object

Dictionary entries that match the query. For details, see the dictionaryEntries parameter.

nbHits · integer

Number of dictionary entries that matched the query.

nbPages · integer

Number of pages in the paginated response.

page · integer

Page number of the paginated response.

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

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