searchsuggest Action

Provides suggestions as the user enters text into a form field.

Parameters

Parameters allow for data to be passed to the action.

Name Type Nullable Unicode Description
fuzzy
Edm.Boolean True True Use fuzzy search to aid with misspellings. The default is false.
filter
Edm.String True False Filter criteria to reduce results returned.
propertybag
Edm.String True False A collection of additional properties for search request. Eg. appid, correlationid.
orderby
Edm.String True False List of comma-separated clauses where each clause is an attribute name followed by 'asc' or 'desc'.
options
Edm.String True False Options are settings configured to search a search term. Eg. lucene, besteffortsearch, groupranking, searchmodelall.
top
Edm.Int32 True True Number of suggestions to retrieve. The default is 5.
search
Edm.String False False Search term.
entities
Edm.String True False The default is searching across all search–configured entities.

Return Type

Type Nullable Description
searchsuggestResponse False The searchsuggest action returns the following value.

See also