Query Object

The Query Object allows to specify a query as * a query string * a list of parsed query parts (from previous queries)

When a query (user-typed or generated) is sent to the API, it is interpreted and returned as a list of query parts. These can be visualized to the user and allow for alteration, such as removing parts from the list. On subsequent calls to the API, the list of parsed query parts can be supplied in place of the query string.

When a request contains query parts (from the previous query) together with a new query string, the query parts resulting from interpretation of the new query are merged with the previous query parts.

Only the query string gets interpreted (spelling correction, location resolving, synonym expansion). The query parts are not interpreted again, since they are supposed to come from a previous search request, and hence are already interpreted.

QueryString 🔗︎ string

QueryString

Query (see query language description). It may be joined with the queryParts if it is a single OR-combination part that can be joined.

A full defined list of the searchable candidate fields and their examples can be found here.

QueryParts 🔗︎ object[]

QueryPartsList of QueryPart

List of query parts coming from parsing a previous query.