API Reference / API Parameters / advancedSyntax

Jan. 14, 2021

advancedSyntax

Type: boolean

Engine default: false

Parameter syntax

'advancedSyntax' => true|false

advancedSyntax: true|false

advancedSyntax: true|false

'advancedSyntax': True|False

advancedSyntax = true|false

advancedSyntax: Boolean = true|false

new JSONObject()
  .set("advancedSyntax", true|false)

IndexSettings settings = new IndexSettings();
settings.AdvancedSyntax = true|false;

.setAdvancedSyntax(true|false)

opt.AdvancedSyntax(true|false)

advancedSyntax = Some(true)

Can be used in these methods:
search, setSettings, browseObjects, 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, browseObjects, 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, generateSecuredApiKey, addAPIKey, updateAPIKey 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

Enables the advanced query syntax.

This advanced syntax brings two additional features:

Phrase query: a specific sequence of terms that must be matched next to one another. A phrase query needs to be surrounded by double quotes ("). For example, the query "search engine" only returns a record if it contains “search engine” exactly in at least one attribute.

Note: Typo tolerance is disabled inside the phrase (i.e. within the quotes).
Prohibit operator: excludes records that contain a specific term. To exclude a term, you need to prefix it with a minus (-). The engine only interprets the minus (-) as a prohibit operator when you place it at the start of a word. A minus (-) within double quotes (") is not treated as a prohibit operator.

Some examples:
- search -engine only matches records containing “search”, but not “engine”
- search-engine matches records containing “search” and “engine” (there’s no exclusion because the minus (-) is in the middle of the word)
- -search matches every record except those containing “search”
- -search engine matches records containing “engine”, but not “search”
- "-engine" matches records containing “-engine” (no exclusion performed)

Examples

Enable advanced syntax by default

Copy

1
2
3
$index->setSettings([
  'advancedSyntax' => true
]);

1
2
3
4
5
6
7
8
let settings = Settings()
  .set(\.advancedSyntax, to: true)

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Enable advanced syntax for the current search

Copy

1
2
3
$results = $index->search('query', [
  'advancedSyntax' => true
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.advancedSyntax, to: true)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

advancedSyntax

About this parameter

Examples

Enable advanced syntax by default

Enable advanced syntax for the current search

Did you find this page helpful?

On this page