# Data Format for Search Suggest

### File Input Format <a href="#dataintegrationspecification-csvproductdata-fileinputformat" id="dataintegrationspecification-csvproductdata-fileinputformat"></a>

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 <a href="#dataintegrationspecification-csvproductdata-blacklist.csv" id="dataintegrationspecification-csvproductdata-blacklist.csv"></a>

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**](http://en.wikipedia.org/wiki/Tab_key) (\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 | <p><br></p>                                                                                              |
| Locale                    | i18n localisation definition                                                 | Empty or a valid [Java Locale](http://www.oracle.com/technetwork/java/javase/javase7locales-334809.html) |

**Example**

|           |        |
| --------- | ------ |
| perfume   | en\_GB |
| ted baker | en\_GB |
| merde     | fr\_FR |

#### whitelist.csv <a href="#dataintegrationspecification-csvproductdata-whitelist.csv" id="dataintegrationspecification-csvproductdata-whitelist.csv"></a>

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**](http://en.wikipedia.org/wiki/Tab_key) (\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 | <p><br></p>                                                                                              |
| Locale                    | i18n localisation definition                                             | Empty or a valid [Java Locale](http://www.oracle.com/technetwork/java/javase/javase7locales-334809.html) |

**Example**

|                |        |
| -------------- | ------ |
| dresses        | en\_GB |
| alexander wang | en\_GB |
| robes          | fr\_FR |
