cloudsearch/aws.sdk.kotlin.services.cloudsearch.model/DocumentSuggesterOptions

DocumentSuggesterOptions

class DocumentSuggesterOptions

Options for a search suggester.

Types

Builder

class Builder

Companion

object Companion

Properties

fuzzyMatching

val fuzzyMatching: SuggesterFuzzyMatching?

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

sortExpression

val sortExpression: String?

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

sourceField

val sourceField: String

The name of the index field you want to use for suggestions.

Functions

copy

inline fun copy(block: DocumentSuggesterOptions.Builder.() -> Unit = {}): DocumentSuggesterOptions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String