Suggest Service Data Format

This section describes how to prepare data for the Fredhopper Suggest Service.

File Input Format

There are two CSV files that allow the customisation of the keyword suggestions that are returned in the Suggest query responses from Fredhopper. These are:

• blacklist.csv - used to remove suggestions which are found in the historic search data

• whitelist.csv - used to add any additional suggestions which are not found in the historic search data

blacklist.csv

The blacklist.csv file must adhere to the following guidelines:

• Blacklisted terms must be provided in a file named blacklist.csv

• Columns are separated by double tabs (\t\t)

• UTF-8 encoded with standard PC end of line sequencing (\r\n)

• Only printable characters, i.e. no control characters

• All columns are in the defined order and have the defined headers

• The last line in the file should be blank (0 character length)

Searchterm to be excluded	Word or phrase which should not be included in the available suggestions
Locale	i18n localisation definition	Empty or a valid Java Locale

Example

perfume	en_GB
ted baker	en_GB
merde	fr_FR

whitelist.csv

The whitelist.csv file must adhere to the following guidelines:

• Whitelisted terms must be provided in a file named whitelist.csv

• Columns are separated by double tabs (\t\t)

• UTF-8 encoded with standard PC end of line sequencing (\r\n)

• Only printable characters, i.e. no control characters

• All columns are in the defined order and have the defined headers

• The last line in the file should be blank (0 character length)

Searchterm to be included	Word or phrase which should be included in the available suggestions
Locale	i18n localisation definition	Empty or a valid Java Locale

Example

dresses	en_GB
alexander wang	en_GB
robes	fr_FR