sdk-search / com.tomtom.online.sdk.search.fuzzy / FuzzySearchEngineDescriptor

FuzzySearchEngineDescriptor

@PublicPreview("2021.06") data class FuzzySearchEngineDescriptor

Describes the configuration of the Fuzzy Search engine.

Parameters

limit - The maximum number of search results that will be returned.

offset - The starting offset of the returned results within the full result set.

typeAhead - If this flag is set to true, the query will be interpreted as a partial input and the search will enter predictive mode.

categorySearchEnabled - Determines whether the Category Search is enabled.

categorySet - Restricts the POIs in the response to those whose ID is listed.

minFuzzyLevel - The minimum fuzziness level to be used. The default value is 1. The maximum value is 4.

maxFuzzyLevel - The maximum fuzziness level to be used. The default value is 2. The maximum value is 4.

extendedPostalCodes - Indexes for which extended postal codes should be included in the results.

brandSet - A list of brand names which could be used to restrict the result to specific brands.

language - The language in which search results should be returned. Should be one of the supported IETF language tags. See https://developer.tomtom.com/search-api/search-api/supported-languages for more details.

geopoliticalView - Defines what kind of geopolitical view should be used.

idx - A comma-separated list of indexes which should be utilized for the search.

Types

Builder

class Builder

Builder used to create an instance of FuzzySearchEngineDescriptor. Once constructed, the user cannot change the field values.

Properties

brandSet

val brandSet: Set<String>

A list of brand names which could be used to restrict the result to specific brands.

categorySearchEnabled

val categorySearchEnabled: Boolean

Determines whether the Category Search is enabled.

categorySet

val categorySet: Set<Long>

Restricts the POIs in the response to those whose ID is listed.

extendedPostalCodes

val extendedPostalCodes: String?

Indexes for which extended postal codes should be included in the results.

geopoliticalView

val geopoliticalView: String?

Defines what kind of geopolitical view should be used.

idx

val idx: String?

A comma-separated list of indexes which should be utilized for the search.

language

val language: String?

The language in which search results should be returned. Should be one of the supported IETF language tags. See https://developer.tomtom.com/search-api/search-api/supported-languages for more details.

limit

val limit: Int?

The maximum number of search results that will be returned.

maxFuzzyLevel

val maxFuzzyLevel: Int

The maximum fuzziness level to be used. The default value is 2. The maximum value is 4.

minFuzzyLevel

val minFuzzyLevel: Int

The minimum fuzziness level to be used. The default value is 1. The maximum value is 4.

offset

val offset: Int?

The starting offset of the returned results within the full result set.

typeAhead

val typeAhead: Boolean

If this flag is set to true, the query will be interpreted as a partial input and the search will enter predictive mode.