TypeAhead

Returns a list of suggested completions for a string that you provide.

This action has three modes:

  • Dictionary. You supply a text document that lists the words that you want to return in the action.

  • Index. QMS retrieves terms from the configured index IDOL Server Content component.

  • Answerbank. QMS retrieves reference questions from an Answer Server Answer Bank system to use as suggestions.

You must set the mode to use and the text string by setting Mode and Text.

You can use the Behavior parameter to change the type of expansion that QMS uses, for example to expand a single word from the start of the user text, or to expand into phrases.

Example

http://12.3.4.56:16000/action=TypeAhead&Mode=Index&Text=Go

This action gets a list of possible expansions for the fragment Go, by using terms in the configure IDOL Content component.

Required Parameters

The following action parameters are required.

Parameter Description
Mode The method to use to generate the suggested terms.
Text The string that you want to expand with type-ahead suggestions.

Optional Parameters

This action accepts the following optional parameters.

Parameter Description
Behavior The method to use to expand the user text.
FieldRestriction The IDOL Server fields to use to find expanded terms.
MaxResults The maximum number of suggestions to return.
MinScore The minimum score a suggestion must have.
SecurityInfo The user security information that you want to use to restrict the suggestions.
TermExpandParameter Additional parameters to add to the TermExpand action that QMS sends for the Index mode.

This action accepts the following standard ACI action parameters.

Parameter Description
ActionID A string to use to identify an ACI action.
EncryptResponse Encrypt the output.
FileName The file to write output to.
ForceTemplateRefresh Forces the server to load the template from disk.
Output Writes output to a file.
ResponseFormat The format of the action output.
Template The template to use for the action output.
TemplateParamCSVs A list of variables to use for the specified template.