generator step

The generator step imports events from a file or URL. Often the events imported will be documents, but they may also be labels and label answers. The step follows this format:

- run-embedded: generator "file or URL"

Example using docs.jsonl file

Suppose that we create a docs.jsonl file containing several documents:

{"data":{"title":"The Beehive Theory"},"type":"document","uri":"https://pubmed.ncbi.nlm.nih.gov/16999303/"}
{"data":{"title":"Do ambient urban odors evoke basic emotions?"},"type":"document","uri":"https://pubmed.ncbi.nlm.nih.gov/24860522/"}
{"data":{"title":"All abuzz. Angry bees ignite an unexpected MCI."},"type":"document","uri":"https://pubmed.ncbi.nlm.nih.gov/16999303/"}

We can create a flow that imports the documents like this:

sr.yaml

reviewer: mailto:user@example.com

flows:
  import-docs:
    steps:
      - run-embedded: generator docs.jsonl

Example using a URL

We can import events from a URL instead of a file. This example imports all of the documents, labels, and label answers from the public Mangiferin systematic review.

sr.yaml

reviewer: mailto:user@example.com

flows:
  import-mangiferin:
    steps:
      - run-embedded: generator https://sysrev.com/web-api/srvc-events?project-id=21696

History

Version 0.9.0 (2022-12-12)

generator-file was renamed to generator, and URL support was added. generator-file is now an alias for generator.