Skip to content

Analyze test documents

Analyzing the test documents is the key activity to:

  • Check how your project performs.
  • Examine the results.
  • Decide how to keep developing and fine-tuning the rules and any script.
  • Check if the project is ready to be deployed.

Each analysis operation submits the single document to the entire processing pipeline, excluding the preparation.

When it involves multiple documents, the analysis produces reports that can be compared to determine if the quality of the project improves, gets worse or is stable as the rules change.

Info

The analysis operation automatically determines whether the code has changed since the last run and in case performs a build. Check the Console and Notifications for any possible compilation errors.

Note

The standard text size is 500 KB, extendable to 2 MB in the configuration properties.

Analyze the document in focus in the editing area

To analyze the document in focus in the editing area:

  • In the main toolbar, select Analyze Document .

Or:

  • From the main menu, select Studio > Analyze Document.

Or:

  • Press F5.

Or:

  • Right-click anywhere in the text and choose Analyze Document.

A notification is displayed in lower right corner.

You cannot analyze test files in the documents folder. Such a folder is used for document preparation. If you perform an analysis, a warning will appear asking you to start the document preparation.

Analyze a selection of documents in the module or project

To analyze a selection of documents in the module or project:

  1. Select a file or a set of files (CTRL+click is allowed) or a folder.
  2. Select Analyze Selection in the context menu.
  3. Type a report name under Report label or confirm the suggested one.
  4. From the Analyze with drop-down menu, select:

    • Current Knowledge Graph (with definitions) versionNumber to analyze documents with the current Knowledge Graph and disambiguator.

    Or:

    • KG Runtimes versionNumber to analyze documents with the current version of the Knowledge Graph but a different version of the disambiguator.
  5. Check Cache analysis results on disk to cache results on disk.

  6. Check Compute quality metrics with tolerance on match position to accept annotations without considering their position in the text.
  7. Check Enable Analysis Debug Info to display debug information in the Statistics tool window when analyzing a selection of documents.

    Note

    This can also be set in the configuration properties.

  8. Select Yes or press Enter.

Tip

Use Platform for more detailed quality metrics.

Analyze all the documents in the module or project

To analyze all the documents in the module or project:

  1. In the Project tool window, from context menu, select Analyze All Documents.

    Or:

    From the main menu, select Studio > Analyze All Documents.

    Or:

    In the main toolbar, select Analyze All Documents .

  2. Type a report name under Report label or confirm the suggested one.

  3. From the Analyze with drop-down menu, select:

    • Current Knowledge Graph (with definitions) versionNumber to analyze documents with the current Knowledge Graph and disambiguator.

    Or:

    • KG Runtimes versionNumber to analyze documents with the current version of the Knowledge Graph but a different version of the disambiguator.
  4. Check Cache analysis results on disk to cache results on disk.

  5. Check Compute quality metrics with tolerance on match position to accept annotations without considering their position in the text.
  6. Check Enable Analysis Debug Info to display debug information in the Statistics tool window when analyzing a selection of documents.

    Note

    This can also be set in the configuration properties.

  7. Select Yes or press Enter.

Select View Report in the notification at the right bottom corner, to display the analysis report in the Report tool window.

While multiple documents are analyzed, select Abort Analysis on the toolbar to stop the analysis. A dialog will appear for confirmation.

Tool windows and analysis output

The tool windows affected by the analysis process are: