execute

open override fun execute(params: IPluginServletActionParams): IPluginServletActionRetVal

Does, if activated by the CodBi-Plugin-Property Active_AI containing OCR, use AI's janitor to store images that have an ID (if transmitted in the header X-OCR-Image-ID) and extracts all the text from the transmitted, or via X-OCR-Image-ID specified, images.

X-Mode Options (case-insensitive):

  • print (default): Plain text extraction - extracts all text from the image(s).

  • extract: Extracts text from image(s) and returns only the parts that match the regex pattern specified in the X-Pattern header.

  • verify: Extracts text from image(s) and checks if the text matches the regex pattern specified in the X-Pattern header.

  • extract fields: Extracts text from image(s) and applies multiple regex patterns from the X-FieldPatterns header (JSON array) to extract field values.

Return

A proper IPluginServletActionRetVal.

Parameters

params

As provided by the formcycle environment.