Named Entity Recognition 25.3
Named Entity Recognition User and Programming Guide

# Dictionary ResourceFile Format

For dictionary pre-filtering, you can either use a provided dictionary file, or create one yourself. The provided dictionary files are in binary format, and have the extension DPF. You can create custom files in JSON format, which must use the following JSON schema:

    {
       "id": "eduction#DictionaryPrefilter",
       "$schema": "http://json-schema.org/draft-07/schema",
       "description": "Schema for Named Entity Recognition dictionary prefilter serialization",
       "type": "object",
       "properties": {
          "type": {
             "description": "Type of prefilter",
             "enum": [
                "dictionary"
             ]
          },
          "dictionary_words": {
             "description": "Array of words to use as the dictionary for the prefilter",
             "type": "array",
             "items": {
                "type": "string",
                "minLength": 1
             },
             "minItems": 1,
             "uniqueItems": true
          }
       },
       "additionalProperties": false,
       "required": [
          "type",
          "dictionary_words"
       ]
    }

For example:

    {
       "type": "dictionary",
       "dictionary_words": [
          "Smith",
          "Jones"
       ]
    }

This simplified example pre-filters by finding any instance of the words Smith or Jones in the text. It then creates a text window around these simple matches, which it uses to perform the full match.

NOTE: Dictionary terms are case-sensitive. If you want to include multiple case options, you must add them all to the dictionary.

Copyright 2013-2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Named Entity Recognition 25.3

Topic Title: Dictionary ResourceFile Format