OpenAISummarizePDF Step

Use this step to summarise the PDF document

Last published at: October 17th, 2024

Description:

This step is used to summarise the PDF document on the application server. 

 

Inputs

  • actAs – Act As A Persona
  • model – OpenAI API model to use
  • pdfFilePath – PDF file path on the application server
  • varGlobalStoreResult – variable/global to store the summary result
 

 

Returns

  • True – step executed successfully
  • False – step failed to execute 
 

 

Usage:

 

 

Example:

Let’s build and execute the “OpenAISummarizePDFDef” example.          

  • Create a new definition called “OpenAISummarizePDFDef”
  • Select the definition and click the “design” button
  • Drag a “OpenAISummarizePDF” step from the toolbox
  • Connect the dots between the start and “OpenAISummarizePDF” step
  • Define a variable/global to store the summary result after execution
  • Click the "OpenAISummarizePDF" step to configure its "Settings" properties. Select the OpenAI API model from the drop-down list. Provide the source PDF file path on the application server. Provide the variable/global reference to store the summary result. 

 

  • Click the "OpenAISummarizePDF" step to configure its "Advanced" properties. Provide the persona reference to Act As. 

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new instance, and execute. Render the process instance. Click on the process step to view its properties. The step should summarise the PDF document and store the result in a variable/global. 
  • Below is a summary of the “Google_Terms_Of_Service_EN_IN.pdf” document as a “Developer” persona for reference. 

 

  • Below is a summary of the “Google_Terms_Of_Service_EN_IN.pdf” document as a “Business User” persona for reference. 

 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.

Click here to download the sample file.

 

 Note: The terms of service document used in this example is available for download here.