Skip to content

DocumentSuggesterOptions

Source code in docs_src/capo_cloudsearch/types/document_suggester_options.py 
16
17
18
19
20
21
22
23
24
class DocumentSuggesterOptions(TypedDict, closed=True):
    source_field: "capo_cloudsearch.types.field_name.FieldName"
    """<p>The name of the index field you want to use for suggestions. </p>"""
    fuzzy_matching: NotRequired[
        "capo_cloudsearch.types.suggester_fuzzy_matching.SuggesterFuzzyMatching"
    ]
    """<p>The level of fuzziness allowed when suggesting matches for a string: <code>none</code>, <code>low</code>, or <code>high</code>. 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. </p>"""
    sort_expression: NotRequired["capo_cloudsearch.types.string.String"]
    """<p>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 <code>_score</code> 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.</p>"""

fuzzy_matching instance-attribute 

fuzzy_matching: NotRequired[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.

sort_expression instance-attribute 

sort_expression: NotRequired[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.

source_field instance-attribute 

source_field: FieldName

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