API Reference / API Parameters / minWordSizefor1Typo

Nov 25, 2021

minWordSizefor1Typo

Type: integer

Engine default: 4

Formerly: minWordSizeForApprox1

Parameter syntax

'minWordSizefor1Typo' => min_word_size

minWordSizefor1Typo: min_word_size

minWordSizefor1Typo: min_word_size

'minWordSizefor1Typo': min_word_size

minWordSizefor1Typo = min_word_size

minWordSizeFor1Typo: Int = min_word_size

IndexSettings settings = new IndexSettings();
settings.MinWordSizefor1Typo = min_word_size;

.setMinWordSizefor1Typo(min_word_size)

opt.MinWordSizefor1Typo(min_word_size)

minWordSizefor1Typo = Some(min_word_size)

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, 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

The minimum number of characters in a query word before typos are considered.

Changing this setting to a lower value than the default (4) can lead to more matches, which might reduce relevance for short queries.

API reference minWordSizefor2Typos

Examples

Set the default minimum character count to allow one typo

Copy

1
2
3
$index->setSettings([
  'minWordSizefor1Typo' => 4
]);

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

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

Override the default minimum character count to allow one typo for the current search

Copy

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

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

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

Did you find this page helpful?