Vocabularies for Synonyms and Suggest

Copyright ©

Mindbreeze GmbH, A-4020 Linz, 2018.

All rights reserved. All hardware and software names used are registered trade names and/or registered trademarks of the respective manufacturers.

These documents are highly confidential. No rights to our software or our professional services, or results of our professional services, or other protected rights can be based on the handing over and presentation of these documents.

Distribution, publication or duplication is not permitted.

The term ‘user‘ is used in a gender-neutral sense throughout the document.

IntroductionPermanent link for this heading

Vocabularies specify preferred and alternative terms for search terms.

An Example:
SearchTerm;PrefLabel;AltLabel;Definition;Disabled advanced;help;cheat sheet;Query Language easter egg;hidden feature;inside joke;Query Language;TRUE

When the VocabularySynonymTransformer plugin is installed, entries are treated as synonyms. The search for „advanced“ is extended to „help“ and „cheat sheet“, whereas the prefLabel is always given more weight than the altLabel. Synonyms are also used reversely; a search for „cheat sheet“ also searches for „advanced“ and „help“. Here is to be noted, that there are no quotes allowed in the synonym-files.

ConfigurationPermanent link for this heading

Configurations can be performed under the „Indices“ tab in section „Query Transformation Services“ as well as under the „Client Services“ tab in section „Suggest Settings“.

The path to the CSV file can be declared in section „Suggest Settings (Concept CSV).

As an alternative, you can specify in “CSV File Pattern” a pattern to select the CSV-file dynamically. Therefore, “CSV File Path” is interpreted as directory, and all containing CSV-files are loaded at startup. If a search sends a SuggestRequest, you can specify additional options that are being sent. These options, together with the “CSV File Pattern”, select the concrete CSV-File used for this SuggestRequest. E.g. If the “CSV File Pattern” suggests_{{lang}}_{{source}}.csv is set and a SuggestRequest contains the options lang:en, source:default, the concrete CSV-File suggests_en_default.csv will be selected for this request.

The setting has to be enabled:

Next, a new Query Transformation Service must be added (Indices tab).
(Choose dropdown value and klick „Add“)

By clicking the plus sign the lately added service is expanded and the file path to the vocabulary file is displayed.

You can find an example for a vocabulary CSV file in .

As an alternative to the CSV-File format, you can use the Google-Search-Appliance (GSA) file format. Choose “Vocabulary File Format“: Google GSA and provide for “Vocabulary File Path“ the vocabulary file paths. You can provide multiple files.

For GSA-Files, you can also provide a base directory and a regular expression. All matching files, that are located directly in the base directory, will be loaded.

If a regular expression is used, new files are not detected automatically. However, if an old GSA-File is modified, the whole List of GSA-Files are reloaded (including possible new Files)

Differences between the Plugins Synonym Transformer and the Vocabulary Synonym TransformerPermanent link for this heading

Both plugins transform queries to include synonyms. However there are a few differences:

Synonym Transformer Plugin:Permanent link for this heading

  • Uses a single CSV-File
  • CSV-Syntax: 2 or more Columns
  • All synonyms have the same weight
  • Only single terms without whitespace are supported

Vocabulary Synonym Transformer Plugin:Permanent link for this heading

  • Can be used with multiple CSV or GSA syntax files
  • CSV-Syntax: 3 columns
  • Depending on the column the synonyms have less weight
  • Support for multi-word-terms

AutocompletePermanent link for this heading

Allows you to use autocomplete (autosuggestion) in an input field.

Example:Permanent link for this heading

<input data-template="suggest"        










SettingsPermanent link for this heading

  • property: The metadata to be used for the completion. Default: title
  • property-constraint: A search term to limit the possible values. Default: empty
  • count: The number of suggestions. Default: 4
  • source: DOCUMENT_PROPERTY supplies suggestions from metadata, QUERY_TERM from previous searches and CONCEPT from a concept index. For QUERY_TERM and CONCEPT additional settings in the Mindbreeze configuration are necessary. Default value: DOCUMENT_PROPERTY
  • service: URL for a  Suggest service. Default value: empty – the same as search
  • disabled: Suggestions are disabled. Default: empty
  • source-id-pattern:  recent_query provieds suggestions from recent searches
  • grouped: Groups the results (true/false) – Default: true
  • show-onfocus: Show suggestions when Inputelement is focused (true/false) – Default: false

Settings for suggested search terms can be performed as follows:

Similar Terms

Enable Suggesting of Similar Queries: If checked, suggests are fetched from the App.Teletry database

ID: An ID might be assigned (e.g. for Styling purpose)

Source Name: The source name might be for example “Popular Searches”

Database JDBC URL: URL to the App.Telemetry database

Table Name: Table name from the App.Telemetry configuration

Table Column for Query: Selection for count of the results (from the App.Telemetry configuration)

Table Column for Score: Selection for column names of the results (from the App.Telemetry configuration)

Table Column for View ID: Selection for column names of the query (from the App.Telemetry configuration)

Additional WHERE Clause: An aditonal “WHERE” clause can be created and added

Suggest If User Query Is Empty: if “true”, suggestions are displayed, also when the user has not searched yet.

Concept CSV

Enable Suggesting from CSV File: If checked, suggests are fetched from an CSV file

ID: An ID might be assigned (e.g. for Styling purpose)

Source Name: The source name might be for example “Words and Terms”

CSV File Path: The path to the CSV file