Debugging a Taxonomy

In order to see how your taxonomy works against actual data, use the debug features built into the Taxonomy Editor. 

There are two debugging options available in the Taxonomy Editor: Preview and Single Tests. Preview allows users to run tests against taxonomy labels with existing data streams. Single Tests allow users to run tests against taxonomy labels with user-inputed text. 

Preview: Debug against a data stream

If you want to run your taxonomy against a specific data stream to see whether it is returning the documents as expected, use Preview. 

1. On the Models page, navigate to the Taxonomy tab and select the taxonomy you wish to debug. This will bring you to the Taxonomy Editor.  

2. Click the card of the taxonomy that you want to debug, and in the taxonomy editor that appears, click Debug Taxonomy, and select Run. In the Taxonomy Editor, to the right of the search bar, click the Run button. The Run button is represented by a "Play" icon. In the dropdown that appears, select "Preview." 

4. On the last window, you will be asked to select the text dimension in the dataset with which to test and given the option to have Quotes produced from your test. Once you have made your selections, click "Submit." 

5. After submitting, a random sample of your selected data stream will be tested against your taxonomy logic. By default, data will be tested against the logic contained in the label you have selected to open in the editor. In the example below, data is being tested against logic in the "ATM Downtime" label. 

6. Matched results will have highlighted words and phrases that meet a label's logic. Hovering over highlighted words will provide additional information on the logic itself. Users can also change the preview range to include matches for a parent label and switch to another data stream entirely. 

7. Close the Preview window by click the "X" in the top righthand corner. 

Single Tests: Debug against specific text

If you want to run a specific verbatim against taxonomy logic, use Single Tests. 

1. On the Models page, navigate to the Taxonomy tab and select the taxonomy you wish to debug. This will bring you to the Taxonomy Editor.  

2. Click the card of the taxonomy that you want to debug. In the Taxonomy Editor, select the label you wish to test. Then, to the right of the search bar, click the Run button. The Run button is represented by a "Play" icon. In the dropdown that appears, select "Run single tests." 

3. In the dialog that appears, enter text you expect to match the label that you want to test and click Run.

4. Labels found in the text appear highlighted in the Matching Result area below. Hover over them to get more details on the nature of the match. 

Further questions?

We're here to help! Don't hesitate to contact us for further assistance via chat or submit a ticket!