Interface Suggester
- All Known Implementing Classes:
DocumentLookupSuggester
,UserGroupLookupSuggester
public interface Suggester
-
Method Summary
Modifier and TypeMethodDescriptionvoid
initWithParameters
(SuggesterDescriptor descriptor) Configure the Suggester instance with the parameters from the XML descriptor.suggest
(String userInput, SuggestionContext context) Compute a list of possible user actions or intents given their input and context.
-
Method Details
-
suggest
Compute a list of possible user actions or intents given their input and context.- Parameters:
userInput
- text typed by the usercontext
- user context- Returns:
- generated suggestion for the given input and context
- Throws:
SuggestionException
- if the configuration or context are inconsistent, or a backing service is failing.
-
initWithParameters
Configure the Suggester instance with the parameters from the XML descriptor.- Parameters:
descriptor
- XMap descriptor with the aggregate configuration information of the component.- Throws:
ComponentInitializationException
-