Dispatch a Query to Several Suggest Dictionaries

Suggest dispatchers allow you to use several suggests in a single query and therefore quickly refine your data at search time.

You can:

  • Map prefix handlers to suggest dictionaries and then start queries made of several prefixes and associated suggests.

  • Define a default suggest to get suggestions without entering prefix handlers in the search field. By combining this default suggest with prefix handler/ suggest pairs, you can further extend search suggestion possibilities.

This task shows you how to:

See Also
About Search Suggestions
Create a Suggest Dictionary

Add and Configure a Suggest Dispatcher

  1. Click Add suggest dispatcher, enter a name, and click Accept.
  2. Specify the options to apply:

    Option

    Description

    Match whole query

    Sends the whole query to the default suggest if the cursor is outside a prefix handler.

    For example, if the query is:

    author: "George Lucas" Star Wars

    If the cursor is after the last quote, you are outside the author: prefix handler scope, and:

    • If the option is selected, the suggest is made on the whole query, author: "George Lucas" Star Wars
    • If cleared, the suggest is applied to Star Wars only. author: "George Lucas" is not considered.

    Use default suggest for non configured prefix

    Sends the query to the default suggest if the cursor is within an undefined prefix handler.

    If cleared, undefined prefix handlers are ignored and there is no suggestions.

    Add quotes to suggestions

    Adds quotes where required so that the whole suggestion is included in the prefix handler.

    Add prefix handler to suggestions

    Adds prefix handlers automatically when you enter a query

    Check with search logics

    Selecting specific search logics allows prefix handler suggestion and configuration check while configuring prefix handler/suggest pairs below.

    Max. suggestions

    Allows you to define a maximum number of suggestions to be displayed (default is 0, meaning no limit).

    Note: You can also define a maximum number of suggestions to be displayed for each prefix handler. See below.

    Boost variety

    Allows to retrieve the best matches for each suggest according to the maximum number of suggestions defined previously.

    Note: This mode does not return the best global results but the best results for each suggest.

    Example: a suggest dispatcher is configured to display 10 suggestions maximum, for 3 suggest dictionaries.

    Without Boost variety, you get:

    • Suggest 1: 3 results
    • Suggest 2: 10 results
    • Suggest 3: 8 results

    With Boost variety, you get:

    • Suggest 1: 3 results
    • Suggest 2: 4 results
    • Suggest 3: 3 results

    Prefix handler | Suggest

    Maps a prefix handler to a suggest dictionary. You can map as many pairs as required.

    Select Default to specify the suggest dictionary to use by default for a specific prefix handler.

    Note: You must specify at least one default suggest, using the following options:
    • Match whole query
    • Use default suggest for non configured prefix
    • Add prefix handler to suggestion

    If required, define a maximum number of suggestions to be displayed for each prefix handler in the Max. suggestions field.

  3. Click save and apply your configuration.

    Note: You do not need to rebuild the suggest dictionaries for suggest dispatchers.

Enable a Suggest Dispatcher in Mashup Builder

  1. In Mashup Builder, go to a page using a search form widget, for example the Standard Search Form widget.
  2. Click the widget header to display its properties panel.
  3. On the Suggest tab, complete the following:
    1. Select Enable suggest.
    2. For Action, select dispatcher.
    3. For Suggest Name, click inside the field. From the dynamic list that displays on the left, select the suggest dispatcher previously created in the Administration Console.
  4. Click Save and then apply your changes.
  5. Open the Mashup UI and enter a query using the prefix handlers defined previously.

You get suggests for each of these prefix handlers.

Example: Two Prefix Handlers Mapped to Two Suggests

In the following example, we have set a suggest dispatcher to map two prefix handlers (categories and text) to two different suggests. We are then able to enter queries with the following format: categories: suggestX text: suggestY

  1. Open the Mashup UI and enter a first prefix handler, for example categories: and a few characters to get a first list of suggestions.



  2. Enter a second prefix handler, for example text: and a few characters to get a second list of suggestions.



  3. You can also make this query with the Search API suggest/dispatcher command.

    The URL format is the following: 

    http://<HOSTNAME>:<BASEPORT+10>/suggest/dispatcher/<DISPATCHER_NAME>

    For example, to get the suggest obtained in step 2, we could enter the following URL: 

    http://myhost:10010//suggest/dispatcher/mydispatcher?q=categories:"connectors" text:"mana