API Reference / API Parameters / queryType

Feb. 26, 2019

queryType

Type: string

Engine default: "prefixLast"

Parameter syntax

'queryType' => 'prefixLast'|'prefixAll'|'prefixNone'

queryType: 'prefixLast'|'prefixAll'|'prefixNone'

index.setSettings({
  queryType: 'prefixLast'|'prefixAll'|'prefixNone'
});

'queryType': 'prefixLast'|'prefixAll'|'prefixNone'

"queryType": "prefixLast"|"prefixAll"|"prefixNone"

queryType: QueryType = QueryType.PrefixLast
| QueryType.PrefixAll
| QueryType.PrefixNone

new JSONObject()
  .put("queryType", "prefixLast"|"prefixAll"|"prefixNone");

IndexSettings settings = new IndexSettings();
settings.QueryType = "prefixLast"|"prefixAll"|"prefixNone";

.setQueryType("prefixLast"|"prefixAll"|"prefixNone")

opt.QueryType("prefixLast"|"prefixAll"|"prefixNone")

queryType = Some(QueryType.prefixLast|QueryType.prefixAll|QueryType.prefixNone)

Can be used in these methods:
search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, browse, searchForFacetValues search, setSettings, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, setSettingsAsync, browseAsync, searchForFacetValues Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Controls if and how query words are interpreted as prefixes.

Options:

prefixLast: Only the last word is interpreted as a prefix (default behavior).
prefixAll: All query words are interpreted as prefixes. This option is not recommended, as it tends to yield counterintuitive results and has a negative impact on performance.
prefixNone: No query word is interpreted as a prefix. This option is not recommended, especially in an instant search setup, as the user will have to type the entire word(s) before getting any relevant results.

Examples

Set default query type

Copy

$index->setSettings([
  'queryType' => 'prefixLast'
  // 'queryType' => 'prefixAll'
  // 'queryType' => 'prefixNone'
]);

IndexSettings settings = new IndexSettings();
settings.QueryType = "prefixLast";
// settings.QueryType = "prefixAll";
// settings.QueryType = "prefixNone";

index.SetSettings(settings);

client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    queryType = Some(QueryType.prefixLast)
    // queryType = Some(QueryType.prefixAll)
    // queryType = Some(QueryType.prefixNone)
  )
}

Override default query type for the current search

Copy

$results = $index->search('query', [
  'queryType' => 'prefixAll'
  // 'queryType' => 'prefixLast'
  // 'queryType' => 'prefixNone'
]);

let query = Query(query: "query")
query.queryType = .prefixAll
//query.queryType = .prefixLast
//query.queryType = .prefixNone

index.search(query, completionHandler: { (res, error) in
    print(res)
})

index.search(new Query("query").setQueryType(Query.QueryType.PREFIX_ALL));
// index.search(new Query("query").setQueryType(Query.QueryType.PREFIX_LAST));
// index.search(new Query("query").setQueryType(Query.QueryType.PREFIX_NONE));

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    queryType = Some(QueryType.prefixAll)
    // queryType = Some(QueryType.prefixLast)
    // queryType = Some(QueryType.prefixNone)
  )
}

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

queryType

About this parameter

Options:

Examples

Set default query type

Override default query type for the current search

Did you find this page helpful?

On this page