Extraction templates

When creating an extractor from extractor modules, an extractor template must be used. The CLI will create and use an extractor template automatically when using the create extractor from-modules command, but if you wish to use a module that requires parameters, or are using the API directly, you will need to use an extractor template.

The templates take the form of json files, such as the following:

{
  "modules": [
    {
      "id": "aluma.name"
    },
    {
      "id": "aluma.simple_text",
      "arguments": {
        "text": "search-text-here"
      }
    }
  ]
}

The top level JSON object must have a modules key, whose value is a JSON list. Each item in that list represents a module.

A module has an id key, and an arguments key.

When using CLI create extractor-template command, the template will be generated for you, with the argument names included. This provides a quick way to customise the modules before then using the create extractor command.