API Reference / API Parameters / exactOnSingleWordQuery

Feb. 26, 2019

exactOnSingleWordQuery

Type: string

Engine default: attribute

Formerly: enableExactOnSingleWordQuery, useQueryEqualsOneAttributeInRanking

Parameter syntax

'exactOnSingleWordQuery' => 'attribute'|'none'|'word'

exactOnSingleWordQuery: 'attribute'|'none'|'word'

exactOnSingleWordQuery: 'attribute'|'none'|'word'

'exactOnSingleWordQuery': 'attribute'|'none'|'word'

"exactOnSingleWordQuery": "attribute"|"none"|"word"

exactOnSingleWordQuery: ExactOnSingleWordQuery = ExactOnSingleWordQuery.Attribute
| ExactOnSingleWordQuery.None
| ExactOnSingleWordQuery.Word

new JSONObject().put(
  "exactOnSingleWordQuery",
  "attribute"|"none"|"word"
);

IndexSettings settings = new IndexSettings();
settings.ExactOnSingleWordQuery = "attribute"|"none"|"word";

.setExactOnSingleWordQuery("attribute"|"none"|"word")

opt.ExactOnSingleWordQuery("attribute"|"none"|"word")

exactOnSingleWordQuery = Some("attribute"|"none"|"word")

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 how the exact ranking criterion is computed when the query contains only one word.

Usage notes:

If exactOnSingleWordQuery is set to word, only exact matches will be highlighted in the _highlightResult property of the search response: partials and prefixes will not be.

Options:

attribute: (default): The exact ranking criterion is set to 1 if the query matches exactly an entire attribute value.

For example, if you search for the TV show “Road”, and in your dataset you have 2 records, “Road” and “Road Trip”, only the record with “Road” is considered exact.
none: The exact ranking criterion is ignored on single word queries.
word: The exact ranking criterion is set to 1 if the query word is found in the record. The query word must be at least 3 characters long and must not be a stop word in any supported language.

Continuing with our “Road” TV show example, in this case, both “Road” and “Road Trip” are considered to match exactly.

Examples

Set default exact ranking criterion computation on single word query

Copy

$index->setSettings([
  'exactOnSingleWordQuery' => 'attribute'
  // 'exactOnSingleWordQuery' => 'none'
  // 'exactOnSingleWordQuery' => 'word'
]);

IndexSettings settings = new IndexSettings();
settings.ExactOnSingleWordQuery = "attribute"};
// settings.ExactOnSingleWordQuery = "none";
// settings.ExactOnSingleWordQuery = "word";

index.SetSettings(settings);

index.setSettings(
  new IndexSettings().setExactOnSingleWordQuery("attribute")
  // new IndexSettings().setExactOnSingleWordQuery("none")
  // new IndexSettings().setExactOnSingleWordQuery("word")
);

client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    exactOnSingleWordQuery = Some("attribute")
    // exactOnSingleWordQuery = Some("none")
    // exactOnSingleWordQuery = Some("word")
  )
}

val settings = settings {
    exactOnSingleWordQuery = ExactOnSingleWordQuery.Attribute
    // exactOnSingleWordQuery = ExactOnSingleWordQuery.None
    // exactOnSingleWordQuery = ExactOnSingleWordQuery.Word
}

index.setSettings(settings)

Override default exact ranking criterion computation on single word query for the current search

Copy

$results = $index->search('query', [
  'exactOnSingleWordQuery' => 'none'
  // 'exactOnSingleWordQuery' => 'attribute'
  // 'exactOnSingleWordQuery' => 'word'
]);

index.search({
  query: 'query',
  exactOnSingleWordQuery: 'none'
  // exactOnSingleWordQuery: 'attribute'
  // exactOnSingleWordQuery: 'word'
}).then(res => {
  // console.log(res);
});

let query = Query(query: "query")
query.exactOnSingleWordQuery = .none
//query.exactOnSingleWordQuery = .attribute
//query.exactOnSingleWordQuery = .word

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

index.search(new Query("query").setExactOnSingleWordQuery(ExactOnSingleWordQuery.NONE));
// index.search(new Query("query").setExactOnSingleWordQuery(ExactOnSingleWordQuery.ATTRIBUTE));
// index.search(new Query("query").setExactOnSingleWordQuery(ExactOnSingleWordQuery.WORD));

index.search(
  new Query("query").setExactOnSingleWordQuery("none")
  // new Query("query").setExactOnSingleWordQuery("attribute")
  // new Query("query").setExactOnSingleWordQuery("word")
);

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    exactOnSingleWordQuery = Some("none")
    // exactOnSingleWordQuery = Some("attribute")
    // exactOnSingleWordQuery = Some("word")
  )
}

val query = query("query") {
    exactOnSingleWordQuery = ExactOnSingleWordQuery.None
    // exactOnSingleWordQuery = ExactOnSingleWordQuery.Attribute
    // exactOnSingleWordQuery = ExactOnSingleWordQuery.Word
}

index.search(query)

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

exactOnSingleWordQuery

About this parameter

Usage notes:

Options:

Examples

Set default exact ranking criterion computation on single word query

Override default exact ranking criterion computation on single word query for the current search

Did you find this page helpful?

On this page