Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

POST /saga/api/client/process/generate

Creates a process unit , with a define defined configuration to identify tags, depending of .  Result data you get depend on the type you choose that will be the result data you would get, and depending whenever .  Depending whether you choose expiration or not , the process unit can be disposable or reusable and even persistent when restarting the server.

Body Parameters

But, what is a Processing Unit anyway?

Before Saga starts processing text it needs to create the processing pipeline containing all different stages defined by the user.  Each stage that could be a Processor or a Recognizer needs to be initialized and added to the pipeline. This pipeline creation process takes time therefore it needs to happen only once and be reused for all the rest of request in order to maximize performance.

 A Processing Unit is basically an object in server's memory where the pipeline instance created with all the configuration defined is stored so it can be reused by subsequent requests.


Body Parameters

  • Parameter
    summaryName of the process unit
    Parameter
    summaryName of the process unit
    defaultdefault
    nameunit
    requiredtrue

...

Process a text using a process unit, for this call we have 2 options put the raw text in the body, or upload a file (.txt only) with the text in itput the raw text in the body, or upload a file (.txt only) with the text in it.


Info

You can use the parameter 'createProcessingUnit' set to true in the query string in order to generate the processing unit before processing the text.

This is useful if you want to only send a single request instead of 2.  Just remember that you'll need to send all parameters needed when creation a Processing Unit described previously


Body Parameters

  • Parameter
    summaryName of the process unit
    defaultdefault
    nameunit
    requiredtrue
  • Parameter
    summaryPath to File
    namedoc
    requiredtrue

...