OpenAI Module
  • 18 Apr 2024
  • 3 Minutes to read
  • Dark

OpenAI Module

  • Dark

Article summary


The OpenAI Module allows using OpenAI's Chat Generative Pre-Trained Transformer (ChatGPT) within the Decisions workflow. With the ability to Fine-Tune language models, users can create, edit, and moderate data to enhance the application's efficiency, accuracy, and productivity.

This document covers the following topics:

OpenAI module is available only for v8.10 and higher versions.

How does OpenAI Module operate?

To access the features of OpenAI, admin users must first install the OpenAI Module. The installation process serves two essential purposes:

  • Exposes OpenAI Settings: This allows the Admin users to enter the OpenAI API Key, ensuring seamless integration with the OpenAI platform.
  • Exposes OpenAI Flow steps: The OpenAI Module provides pre-built Flow Steps that can be used within the workflow to use OpenAI's models.

The OpenAI Module facilitates communication with OpenAI's API. It acts as a bridge between the platform and OpenAI's language models. When users interact with the OpenAI steps within the Flows, it sends requests to the OpenAI API, providing text-based input or prompts for processing.

The OpenAI API then processes these requests using language models, such as GPT-3.5, GPT-4, etc., generating text-based responses based on the input. These responses are then retrieved and made available to users within the Decisions platform.

Use Case

Document Extraction with ChatGPT:

When suppliers send their invoices in an Accounts Payable Process, users manually enter the invoice details into the accounting system. This consumes time and can lead to human errors. With the help of Decisions workflow and OpenAI Module, users can automatically extract important information from the invoices accurately and feed it into the accounting system. This helps save time and reduces errors, making it easier to manage invoices efficiently.

Watch the following YouTube video explaining the above use case in detail:

Generate OpenAI API Keys

Navigate to the OpenAI platform to generate API Keys. Once you have generated the API Key, store it securely for future usage.

Note: Do not use the trial version of OpenAI API on the Production Servers.

Setting Up OpenAI Integration

After installing the Module, as mentioned earlier, OpenAI settings will be exposed within the platform.

  1. Navigate to System > Settings > OpenAI Settings.
  2. Under the API Key field, paste the already generated key from the OpenAI platform.

OpenAI Steps

The OpenAI module provides pre-built Flow steps allowing users to accomplish various AI-driven tasks in the Flow Designer via Toolbox > Integration > OpenAI. Currently, there are 17 OpenAI steps.

Note: Users can override the API key directly at the Step level.

Delete FileThis step allows you to remove a specific file from the system. This step effectively deletes the designated file by providing the file ID as input.
Get File By IDThis step retrieves detailed information about a particular file based on its unique ID.
List FilesThis step retrieves detailed information about a list of files available within the system.
Upload FileThis step enables seamless file uploads into the system. Note: Only JSON Lines file formats will be supported.
Cancel Fine TuneThis step allows you to cancel a fine-tuning process that is currently in progress.
Create Fine TuneUse this step to initiate a new fine-tuning process for an AI model.
Delete Fine TuneThis step enables you to remove a completed or ongoing fine-tuning job.
List Fine Tune EventsRetrieve a comprehensive list of fine-tuning events that have occurred in the system.
List Fine TuneThis step provides a detailed view of all the current fine-tuning jobs within the system.
Retrieve Fine TuneRetrieve specific details of a fine-tuning job by providing its fine-tuning ID.
Create Chat CompletionThis step creates a model response for the given chat conversation.
Create CompletionThis step creates a completion for the provided prompt and parameters.
Create EditThis step allows you to edit or modify existing text using OpenAI's language models.
Create EmbeddingThis step generates embeddings for the given text. Embeddings represent semantic relationships and contextual information about the text, enabling advanced natural language processing.
Create ModerationThis step checks input text against OpenAI's content moderation rules. Ensuring control of the output generated by the AI model is compliant with guidelines.
Get ModelRetrieves a model instance, providing basic information about the model, such as the owner and permissions.
List ModelsLists the currently available models and provides basic information about each, such as the owner and availability.

Was this article helpful?