API Reference / API Parameters / typoTolerance

Jan. 14, 2021

typoTolerance

Type: string | boolean

Engine default: true

Parameter syntax

'typoTolerance' => true|false|'min'|'strict'

typoTolerance: true|false|'min'|'strict'

typoTolerance: true|false|'min'|'strict'

'typoTolerance': True|False|'min'|'strict'

typoTolerance = .true|.false|.min|.strict

typoTolerance: TypoTolerance = TypoTolerance.True
| TypoTolerance.False
| TypoTolerance.Min
| TypoTolerance.Strict

new JSONObject()
  .put("typoTolerance", true|false|"min"|"strict")

IndexSettings settings = new IndexSettings();
settings.TypoTolerance = true|false|"min"|"strict";

.setTypoTolerance(TypoTolerance.of(true|false|"min"|"strict"))

opt.TypoTolerance(true|false)
opt.TypoToleranceMin()
opt.TypoToleranceStrict()

typoTolerance = Some(TypoTolerance.`true`)
                Some(TypoTolerance.`false`)
                Some(TypoTolerance.min)
                Some(TypoTolerance.strict)

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

See code examples

About this parameter

Controls whether typo tolerance is enabled and how it is applied.

Usage notes:

Algolia never returns records with more than 2 typos.
If you use getRankingInfo, you can retrieve the number of typos for each result. Note that you could see 3 typos even with only 2 mistyped letters. This is because Algolia counts a typo on the first letter as 2 typos.
Enabling typoTolerance by setting it to true, min or strict also enables splitting and concatenation.

Options:

true: Typo tolerance is enabled and all records matching with or without typos are retrieved (default behavior).
false: Typo tolerance is entirely disabled. Only records matching without typos are retrieved.
min: Retrieve records with the smallest number of typos.

For example, if the smallest number of typos found is 0, then only records matching without typos will be returned. If the smallest number of typos found is 1, then only records matching with 1 typo will be returned.
strict: Retrieve records with the 2 smallest number of typos.

For example, if the smallest number of typos found is 0, then only records matching with 0 or 1 typo will be returned. If the smallest number of typos found is 1, then only records matching with 1 or 2 typos will be returned.

Strict changes the engine’s ranking, forcing the typo criterion to go the top of the ranking formula.

Examples

Set default typo tolerance mode

Copy

1
2
3
4
5
6
$index->setSettings([
  'typoTolerance' => true
  // 'typoTolerance' => false
  // 'typoTolerance' => 'min'
  // 'typoTolerance' => 'strict'
]);

1
2
3
4
5
6
7
8
9
10
11
let settings = Settings()
  .set(\.typoTolerance, to: true)
//.set(\.typoTolerance, to: false)
//.set(\.typoTolerance, to: .min)
//.set(\.typoTolerance, to: .strict)

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

1
2
3
4
index.setSettings(new JSONObject().put("typoTolerance", true));
// index.setSettings(new JSONObject().put("typoTolerance", false));
// index.setSettings(new JSONObject().put("typoTolerance", "min"));
// index.setSettings(new JSONObject().put("typoTolerance", "strict"));

1
2
3
4
5
IndexSettings settings = new IndexSettings();
settings.TypoTolerance = true;
// settings.TypoTolerance = false;
// settings.TypoTolerance = "min";
// settings.TypoTolerance = "strict";

1
2
3
4
5
6
index.setSettings(
  new IndexSettings().setTypoTolerance(TypoTolerance.of(true))
  // new IndexSettings().setTypoTolerance(TypoTolerance.of(false))
  // new IndexSettings().setTypoTolerance(TypoTolerance.of("min"))
  // new IndexSettings().setTypoTolerance(TypoTolerance.of("strict"))
);

1
2
3
4
5
6
res, err := index.SetSettings(search.Settings{
  TypoTolerance: opt.TypoTolerance(true),
  // TypoTolerance: opt.TypoTolerance(false),
  // TypoTolerance: opt.TypoToleranceMin(),
  // TypoTolerance: opt.TypoToleranceStrict(),
})

1
2
3
4
5
6
7
8
client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    typoTolerance = Some(TypoTolerance.`true`)
    // typoTolerance = Some(TypoTolerance.`false`)
    // typoTolerance = Some(TypoTolerance.min)
    // typoTolerance = Some(TypoTolerance.strict)
  )
}

1
2
3
4
5
6
7
8
val settings = settings {
    typoTolerance = TypoTolerance.True
    // typoTolerance = TypoTolerance.False
    // typoTolerance = TypoTolerance.Min
    // typoTolerance = TypoTolerance.Strict
}

index.setSettings(settings)

Override default typo tolerance mode for the current search

Copy

1
2
3
4
5
6
$results = $index->search('query', [
  'typoTolerance' => false
  // 'typoTolerance' => true
  // 'typoTolerance' => 'min'
  // 'typoTolerance' => 'strict'
]);

1
2
3
4
5
6
7
8
index.search('query', {
  typoTolerance: false
  // 'typoTolerance': true
  // 'typoTolerance': 'min'
  // 'typoTolerance': 'strict'
}).then(({ hits }) => {
  console.log(hits);
});

1
2
3
4
5
6
7
8
9
10
11
let query = Query("query")
  .set(\.typoTolerance, to: false)
  //.set(\.typoTolerance, to: true)
  //.set(\.typoTolerance, to: .min)
  //.set(\.typoTolerance, to: .strict)

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

1
2
3
4
index.search(new Query("query").setTypoTolerance(TypoTolerance.FALSE));
// index.search(new Query("query").setTypoTolerance(TypoTolerance.TRUE));
// index.search(new Query("query").setTypoTolerance(TypoTolerance.MIN));
// index.search(new Query("query").setTypoTolerance(TypoTolerance.STRICT));

1
2
3
4
5
6
7
index.Search<Book>(new Query("query")
{
    TypoTolerance = true
    // TypoTolerance = false
    // TypoTolerance = "min"
    // TypoTolerance = "strict"
});

1
2
3
4
5
6
index.search(
  new Query("").setTypoTolerance(TypoTolerance.of(false))
  // new Query("").setTypoTolerance(TypoTolerance.of(true)))
  // new Query("").setTypoTolerance(TypoTolerance.of("min"))
  // new Query("").setTypoTolerance(TypoTolerance.of("strict"))
);

1
2
3
4
5
6
7
res, err := index.Search(
  "query",
  opt.TypoTolerance(false),
  // opt.TypoTolerance(true),
  // opt.TypoToleranceMin(),
  // opt.TypoToleranceStrict(),
)

1
2
3
4
5
6
7
8
9
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    typoTolerance = Some(TypoTolerance.`false`)
    // typoTolerance = Some(TypoTolerance.`true`)
    // typoTolerance = Some(TypoTolerance.min)
    // typoTolerance = Some(TypoTolerance.strict)
  )
}

1
2
3
4
5
6
7
8
val query = query("query") {
    typoTolerance = TypoTolerance.True
    // typoTolerance = TypoTolerance.False
    // typoTolerance = TypoTolerance.Min
    // typoTolerance = TypoTolerance.Strict
}

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

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

typoTolerance

About this parameter

Usage notes:

Options:

Examples

Set default typo tolerance mode

Override default typo tolerance mode for the current search

Did you find this page helpful?

On this page