/AWS1/CL_SRHDOCSUGGESTEROPTS

Options for a search suggester.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_sourcefield TYPE /AWS1/SRHFIELDNAME /AWS1/SRHFIELDNAME

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

Optional arguments:

iv_fuzzymatching TYPE /AWS1/SRHSUGGESTERFUZZYMATCH00 /AWS1/SRHSUGGESTERFUZZYMATCH00

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.

iv_sortexpression TYPE /AWS1/SRHSTRING /AWS1/SRHSTRING

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.

---

Queryable Attributes

SourceField

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

Accessible with the following methods

Method	Description
GET_SOURCEFIELD()	Getter for SOURCEFIELD, with configurable default
ASK_SOURCEFIELD()	Getter for SOURCEFIELD w/ exceptions if field has no value
HAS_SOURCEFIELD()	Determine if SOURCEFIELD has a value

FuzzyMatching

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.

Accessible with the following methods

Method	Description
GET_FUZZYMATCHING()	Getter for FUZZYMATCHING, with configurable default
ASK_FUZZYMATCHING()	Getter for FUZZYMATCHING w/ exceptions if field has no value
HAS_FUZZYMATCHING()	Determine if FUZZYMATCHING has a value

SortExpression

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.

Accessible with the following methods

Method	Description
GET_SORTEXPRESSION()	Getter for SORTEXPRESSION, with configurable default
ASK_SORTEXPRESSION()	Getter for SORTEXPRESSION w/ exceptions if field has no valu
HAS_SORTEXPRESSION()	Determine if SORTEXPRESSION has a value