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

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, 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 Search, SetSettings, Browse, SearchForFacetValues, GenerateSecuredApiKeys, 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 whether typo tolerance is enabled and how it is applied.

Usage notes

Use getRankingInfo to retrieve the number of typos for each result.
Algolia usually doesn’t return records with more than two typos. You might see records with three typos, if the first letter of a word is mistyped.
If typoTolerance is true, min, or strict, the engine enables splitting and concatenation.
If typoTolerance is min or strict, a rule’s promoted hits might not appear if they contain more typos than the top results.
When used with the browse method, min and strict are treated the same as true.

Options

`true`	Typo tolerance is enabled and all records matching queries with or without typos are retrieved (default behavior).
`false`	Typo tolerance is turned off. Only records matching queries without typos are retrieved.
`min`	Retrieves records with the smallest number of typos.
`strict`	Similar to `min` but keeps the two lowest number of typos and forces the Typo criterion to be first in 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
5
6
7
8
val settings = settings {
    typoTolerance = TypoTolerance.True
    // typoTolerance = TypoTolerance.False
    // typoTolerance = TypoTolerance.Min
    // typoTolerance = TypoTolerance.Strict
}

index.setSettings(settings)

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 {
  setSettings of "myIndex" `with` IndexSettings(
    typoTolerance = Some(TypoTolerance.`true`)
    // typoTolerance = Some(TypoTolerance.`false`)
    // typoTolerance = Some(TypoTolerance.min)
    // typoTolerance = Some(TypoTolerance.strict)
  )
}

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
5
6
7
8
val query = query("query") {
    typoTolerance = TypoTolerance.True
    // typoTolerance = TypoTolerance.False
    // typoTolerance = TypoTolerance.Min
    // typoTolerance = TypoTolerance.Strict
}

index.search(query)

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)
  )
}

Did you find this page helpful?

typoTolerance

About this parameter

Usage notes

Options

Examples

Set default typo tolerance mode

Override default typo tolerance mode for the current search

On this page