@PublicPreview("2021.06") data class FuzzySearchEngineDescriptor
Describes the configuration of the Fuzzy Search engine.
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.
class Builder
Builder used to create an instance of FuzzySearchEngineDescriptor. Once constructed, the user cannot change the field values. |
val brandSet: Set<String>
A list of brand names which could be used to restrict the result to specific brands. |
|
val categorySearchEnabled: Boolean
Determines whether the Category Search is enabled. |
|
val categorySet: Set<Long>
Restricts the POIs in the response to those whose ID is listed. |
|
val extendedPostalCodes: String?
Indexes for which extended postal codes should be included in the results. |
|
val geopoliticalView: String?
Defines what kind of geopolitical view should be used. |
|
val idx: String?
A comma-separated list of indexes which should be utilized for the search. |
|
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. |
|
val limit: Int?
The maximum number of search results that will be returned. |
|
val maxFuzzyLevel: Int
The maximum fuzziness level to be used. The default value is 2. The maximum value is 4. |
|
val minFuzzyLevel: Int
The minimum fuzziness level to be used. The default value is 1. The maximum value is 4. |
|
val offset: Int?
The starting offset of the returned results within the full result set. |
|
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. |