...
Our goal in this KEE project is to identify a salesperson any time that they are referenced in a document, and tag the document with the name of the salesperson, their position, and the name and position of their manager.
Setting up A KEE Project
...
Setting up the initial Configuration
The full reference for the KEE project configuration file can be found here: LINKEvery KEE project requires a configuration file which describes the specific rules for how the KEE project identifies known entities and interacts with a Squirro server
To start, we want to make sure to point the KEE configuration to our list of entities by adding a source to the config.json file as shown below:
...
Finally, we set the keyword items to tag each match with for the name and position of both the matching entity (the salesperson) and the matching parent entity (the salesperson's manager). In this case, we tag each document with the name and position of the matching entity in facets called 'name' and 'position' respectively, while we tag each document with the name and position of the matching parent entity in facets called 'manager name' and 'manager position' respectively.
...
This will provide the kee tool with everything that it needs to authenticate with the squirro server and download individual items to create fixtures. Please see Connecting to Squirro for more information on how to get this information.
Fixtures are created using this method by running the kee get_fixture command:
...
The above command creates a fixture for each of the two squirro items indicated by the unique IDs present in the list. For Please see LINK for more information on how to get the unique ID for a given squirro item, check LINK.
Testing with Fixtures
Once we have a fixture created, we can use the kee command line tool to test the KEE extraction on the fixture. To test a KEE project using the set of fixtures within that KEE project folder, we run the command:
...
If testing the KEE produces results which are different from what is expected, adjustments can be made to the config.json file to improve the results for each specific use case by modifying the way that KEE works. More information on this process can be found here: LINKin the KEE Testing Documentation.
Deploying a KEE Project
Once a KEE project has been tested and produces the desired results, the KEE project can be uploaded to a remote Squirro server to be used for enriching all incoming data.
Similar to creating fixtures from remote Squirro items, deploying a KEE project to a Squirro server requires that the <a>squirro section</a> be squirro section be present within the config.json file. This section includes the information necessary to successfully authenticate with the Squirro server.
...
After the KEE project is uploaded to a Squirro server, the KEE will be available as an enrichment under the <a> Enrich tab </a> of of the Squirro frontend. Each uploaded KEE project requires a unique name which can be customized within the kee field of the section of the config.json file, as shown below.
...