API Reference / API Parameters / advancedSyntaxFeatures

Feb. 26, 2019

advancedSyntaxFeatures

Type: list of strings

Engine default: ["exactPhrase", "excludeWords"]

Parameter syntax

'advancedSyntaxFeatures' => [
  'exactPhrase',
  'excludeWords'
]

advancedSyntaxFeatures: [
  'exactPhrase',
  'excludeWords'
]

advancedSyntaxFeatures: [
  'exactPhrase',
  'excludeWords'
]

'advancedSyntaxFeatures': [
  'exactPhrase',
  'excludeWords'
]

"advancedSyntaxFeatures": [
  "exactPhrase",
  "excludeWords"
]

advancedSyntaxFeatures {
    +ExactPhrase
    +ExcludeWords
}

// This parameter is not available in the Android client.

IndexSettings settings = new IndexSettings
{
  AdvancedSyntaxFeatures = new List<string> { "exactPhrase", "excludeWords" }
}

new IndexSettings()
  .setAdvancedSyntaxFeatures(
    Arrays.asList(
      "exactPhrase",
      "excludeWords"
    )
  )

opt.AdvancedSyntaxFeatures(
  "exactPhrase",
  "excludeWords",
)

advancedSyntaxFeatures = Some(Seq(
  "exactPhrase",
  "excludeWords"
))

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

Allows you to specify which advanced syntax features are active when ‘advancedSyntax’ is enabled.

By default, when advancedSyntax is set to true, all advanced syntax features are enabled.

With this setting, you can disable one or more advanced syntax features.

For example, you can allow users to do exact phrasing (putting words within quotes), but not allow them to exclude words. Example.
Or you can allow users to exclude words (with a ‘-‘) but not do exact phrasing. Example.

See advancedSyntax for more information on its features and usage.

Options:

exactPhrase: 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, "search engine" will only match records having search next to engine.

Note: Typo tolerance is disabled inside the phrase (i.e. within the quotes).
excludeWords: Excludes records that contain a specific term. This term has to be prefixed by a minus (-). For example, search -engine will only match records containing search but not engine.

Examples

Enable all features (the default)

Copy

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

Enable only exact phrase

This example will allow users to use exact phrasing within quotes but not exclude words.

Copy

$results = $index->search('query', [
  'advancedSyntax' => true,
  'advancedSyntaxFeatures' => ['exactPhrase']
]);

let query = Query(query: "query")
query.advancedSyntax = true
query.advancedSyntaxFeatures = ["exactPhrase"]

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

client.execute {
  search into "myIndex" query Query(
    query = Some("query string"),
    advancedSyntax = Some(true),
    advancedSyntaxFeatures = Some(Seq("exactPhrase"))
  )
}

Enable only exclude words

This example will allow users to exclude words but not do exact phrasing.

Copy

$results = $index->search('query', [
  'advancedSyntax' => true,
  'advancedSyntaxFeatures' => ['excludeWords']
]);

let query = Query(query: "query")
query.advancedSyntax = true
query.advancedSyntaxFeatures = ["excludeWords"]

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

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    advancedSyntax = Some(true)
    advancedSyntaxFeatures = Some(Seq("excludeWords"))
  )
}

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

advancedSyntaxFeatures

About this parameter

Options:

Examples

Enable all features (the default)

Enable only exact phrase

Enable only exclude words

Did you find this page helpful?

On this page