Gravity Connect OpenAI

Terminology

Before we get started, let’s clarify a few important words we’ll use throughout this documentation.

• Model: AI models are computational algorithms designed to recognize patterns, make decisions, and predict outcomes based on data.
  • Example: GPT-4o, DALL·E 3, Whisper.
• Endpoint: Specific URL within the OpenAI API where you can send requests to access different AI-powered services, like generating text, creating images, or processing audio. Each endpoint is designed for a particular function, allowing you to interact with OpenAI’s models in various ways.
• Token: Piece of text that an AI processes, ranging from a single character to a whole word. Common words like “apple” are usually one token, while punctuation marks and spaces are also counted as tokens. Some words, like “fantastic,” may be split into multiple tokens depending on the model. Learn more.
• Threads: Conversation session between an Assistant and a user. Threads store messages and automatically handle truncation to fit content into a model’s context.
• GCOAI or OpenAI Connection: Both reference this product.

How do I enable this functionality?

After installing and activating the OpenAI Connection, there are two primary methods for integrating it with your form.

1. OpenAI fields: Use this method if you would like to use AI-generated content within the form itself prior to submission.
2. OpenAI feeds: Use this method if you would like to generate content or process submitted data with AI after submission.

With either method, the first step will be to connect your OpenAI account to the OpenAI Connection.

Connect your OpenAI account

	Log in or create a new account on OpenAI.
	Click on Create new secret key.
	Create a new secret key with your preferred settings. We recommend creating a project and associated project secret key for each site.
	Go to the OpenAI Connection’s plugin settings and paste your key into the Secret Key setting.

Get started with OpenAI fields

	Select an OpenAI field under Advanced Fields.
	Customize your prompt.

Learn more about the OpenAI Connection’s fields.

Get started with OpenAI feeds

	Navigate to your desired form and click the “OpenAI” item under the “Settings” menu.
	Click the “Add New” button to add a new OpenAI feed.
	Choose which OpenAI endpoint to use.
	Customize your prompt.

Learn more about the OpenAI Connection’s feeds.

Feed Settings

When configuring the OpenAI Connection’s feeds, you will be presented with the following settings.

General Settings

You’ll make two important decisions in your feed’s General Settings.

The first is giving your feed a Name. We suggest a name that isn’t too long but will serve as a useful reminder of what this feed does in your workflow.

The second is selecting your desired OpenAI Endpoint. When an endpoint is selected, additional settings related to that endpoint will appear right below General Settings. Each endpoint also has its own advanced settings.

The following sections detail how each endpoint works and why you would use them.

Chat Completions

The Chat Completions endpoint generates text-based responses based on the prompts you provide. Each interaction is self-contained, meaning that once the session ends, the model doesn’t retain any memory of the conversation.

Example Use: If you ask, “What’s the weather like today?” the AI will give you a weather update. Later, if you start a new session and ask, “Should I bring an umbrella?” the AI won’t remember the earlier conversation and won’t know you were asking about the weather. It will treat each prompt as a new, unrelated question.

Model

Select which OpenAI model will be used to generate a response. Click on their names to check their context window and max output tokens.

• GPT-4o: OpenAI’s high-intelligence flagship model for complex, multi-step tasks.
• GPT-4o mini: OpenAI’s affordable and intelligent small model for fast, lightweight tasks. (GPT-4o mini is cheaper and more capable than GPT-3.5 Turbo.)
• GPT-4 Turbo: OpenAI’s previous high-intelligence model.
• GPT-4: OpenAI’s other previous high-intelligence model.
• GPT-3.5: A fast, inexpensive model for simple tasks.

Messages

Write prompts and messages to be sent to OpenAI. The Chat Completion endpoint has three different roles for messages: System, User, and Assistant. You can add, remove, and reorder these messages to better engineer your prompt.

Map Result to Field

Select the field that will have the result attached to its value upon submission.

Advanced Settings: Chat Completions

Timeout: Enter the number of seconds to wait for OpenAI to respond.

Max Tokens: The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens cannot exceed the model’s context length.

Temperature: What sampling temperature to use. Higher values mean the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer. We generally recommend altering this or top_p but not both.

Top-p: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.

Frequency Penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim. See more information about frequency and presence penalties.

Presence Penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model’s likelihood to talk about new topics. See more information about frequency and presence penalties.

Assistants

To use this endpoint, you first need to create an assistant in OpenAI’s playground. There, you will be able to select a model and set up Instructions for your assistants.

Not to be confused with the assistant message role, the Assistants endpoint is tailored for interacting with AI-powered assistants that use OpenAI’s models and can call on tools. Assistants can handle specific tasks, like answering questions, offering recommendations, or performing actions on behalf of the user.

These interactions are contextual within a single session, meaning the assistant can remember previous exchanges during that session.

Example Use: Developing a virtual assistant that helps users plan meals by suggesting recipes based on dietary preferences and available ingredients.

Assistant

Select which assistant you want to use. This will be populated with a list of assistants associated with your OpenAI account.

Messages

Write prompts and messages to be sent to OpenAI. The Assistants endpoint has two different roles for messages: User and Assistant. You can add, remove, and reorder these messages to better engineer your prompt.

About System role: the behavior of the assistant is guided through the Instructions set in its OpenAI settings and its memory from persistent Threads.

This is the tip of the assistants iceberg! We highly recommend reading OpenAI’s documentation on assistants if you are using this endpoint.

Advanced Settings: Assistants

Timeout: Enter the number of seconds to wait for OpenAI to respond.

Max Prompt Tokens: The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run.

Max Completion Tokens: The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run.

Temperature: What sampling temperature to use. Higher values mean the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer. We generally recommend altering this or top_p but not both.

Top-p: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.

Moderations

The Moderations endpoint is used to filter and analyze content for moderation purposes. It assigns scores to entries based on their likelihood of violating OpenAI’s usage policies, and flags any high scores. This information is displayed under the Notes section on the entry details page.

Example Use: Automatically sending offensive entries to spam.

Model

This selection determines which OpenAI Moderation model will be used to check the entry content.

• text-moderation-stable
• text-moderation-latest

Input

Any combination of form data (represented by merge tags) and static text that will be sent to the selected OpenAI model for evaluation. It comes with the {all_fields} merge tag by default.

Behavior

Decide what to do if the submitted input fails validation. You can:

• Do nothing: The submission will be allowed through and the failed validation will be logged as a note on the entry.
• Mark entry as spam: The submission will be allowed through and the entry will be marked as spam. Gravity Forms does not process notifications or feeds for spammed entries.
• Prevent submission by showing validation error: The submission will be blocked and a validation error will be displayed. Due to the nature of how data is sent to OpenAI, specific fields cannot be highlighted as having failed validation.

Advanced Settings: Moderations

Timeout: Enter the number of seconds to wait for OpenAI to respond.

Audio (Text-to-speech)

The Audio (Text-to-speech) endpoint converts written text into spoken words. It takes text input and returns an audio file that you can play as speech.

Example Use: Creating a voice for an AI assistant or converting articles into audio.

Once the form is submitted, the audio can be listened to and downloaded from the entry details page.

Model

Select the OpenAI TTS model to use. Models largely differ in terms of quality.

• tts-1: Optimized for speed.
• tts-1-hd: Optimized for quality.

Voice

Select which OpenAI voice to use. Previews are available in OpenAI’s Text to speech guide.

Field to generate audio from

Select the field that will contain the text you want to generate audio from.

Advanced Settings: Audio (Text-to-speech)

Speed: The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.

Response Format: Select the format of the audio file to generate. Available formats are mp3, opus, aac, flac, wav, and pcm.

Audio (Transcriptions)

The Audio (Transcriptions) endpoint converts spoken language (audio) into written text. It processes audio files and returns the transcribed text as meta.

Example Use: Transcribing meetings, interviews, or voice notes into text for easier review or record-keeping.

Model

Currently, Whisper (whisper-1) is the only available model for this endpoint.

Language

Whisper is capable of transcribing from various languages. Supply the input language in ISO 639-1 format to improve accuracy and latency.

Find the ISO 639-1 code for your language here!

Prompt

Add an optional text prompt to guide the model’s style or continue a previous audio segment. The prompt should match the audio language.

Field to generate transcription from

Select the File Upload field that contains the file to generate a transcription from. The audio transcriptions endpoint supports the following file types: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

Advanced Settings: Audio (Transcriptions)

Temperature: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

Additional Options

Asynchronous Feed

(Available for all endpoints except Moderations.)

If enabled, the OpenAI feed will be processed asynchronously. This is recommended if you want users to be able to submit as quickly as possible. However, it’s not recommended if you have a chain of events dependent on other feeds, like notifications or Gravity Flow. Mapped fields and meta containing responses will not be available to confirmations and notifications.

Conditional Logic

OpenAI feeds will automatically pass through all entries, but with Conditional Logic enabled it will only pass through entries that match certain criteria.

Check the Enable checkbox in the Conditional Logic section and set it like any other Gravity Forms field.

Fields

Other than a feed, the OpenAI Connection comes equipped with two independent field types. The OpenAI Stream field and the OpenAI Image field. You can use these fields to allow for AI generation directly in a form.

OpenAI Stream

The OpenAI Stream field can use Chat Completions and Assistants endpoints.

Field Settings

Model (Chat Completions), Assistants (Assistants), and Messages work the same way described in the feed settings for both endpoints. The Messages setting will stay the same between endpoints.

OpenAI Image

Use this field to generate images using OpenAI image models (such as DALL·E 3). If the field is visible, users will be able to see the generated images.

Field Settings

Prompt: This is the prompt the model will use to generate an image. Accepts Gravity Forms merge tags.

Model: Select which version of the DALL·E model you wish to use.

• DALL·E 2: Generates high-quality images from text prompts.
• DALL·E 3: Generates even more detailed and realistic images with enhanced prompt understanding. Has additional settings.

Size: Select a size for the generated image.

Quality (DALL·E 3): Select the quality for the generated image.

Style (DALL·E 3): Select the style in which the image will be generated.

Additional Settings

These settings are available for both field types.

Trigger Method: Specify when this field should generate results.

• Form Load: The field will generate a result when the form is loaded.
• Button: Displays a button on the field. The field will generate a result when the button is pressed.
• Merge Tag Value Change: This option appears in the drop down when a merge tag is included in the Messages setting. The OpenAI field will generate a result when the target field of the included merge tag is interacted with.
  • Not available for OpenAI Image field due to request costs.

Allow Regeneration: When this option is checked, a Regenerate button will appear below the generated text / image. Useful in case the first try didn’t generate quite what you or the user were looking for, and for generating multiple versions of the same request.

Automatically scroll to bottom of output: Available for OpenAI Stream field. Scrolls to the bottom of the AI’s output.

Prompt Engineering

There are two endpoints that are text based and share the same models: Chat Completions and Assistants. Both endpoints have three key message roles that help structure the conversation between the user and the model, influencing the final output. This process is called “prompt engineering.”

Message Roles

System

The system message serves as a foundation for the entire interaction. It tells the model how to behave, what tone to use, what kind of information to prioritize, and any other relevant guidelines. We recommend using it once as the very first message, to keep the conversation structure clear and straightforward, improving consistency and clarity of output.

Examples:

• You MUST respond in [yes] or [no]
• You are a professional assistant. Respond in a formal and respectful tone, and ensure that your answers are well-structured and thorough.
• I am a technical assistant. I provide detailed explanations with a focus on technical accuracy. I use industry-specific terminology and assume the user has an intermediate level of knowledge in the field.

You can use either “I” or “you” statements.

User

Represents the input from the person interacting with the model. The user role includes all the prompts, questions, or instructions given to the model.

Examples:

• Is the sky blue?
• I’m in Hogsmead. Give me five ideas of what to do this weekend.
• Tell me what I would get if I added powdered root of asphodel to an infusion of wormwood.

Assistant

Not to be confused with the Assistant endpoint, this role is usually the model’s response to the user. It provides the output based on the system’s instructions, the user’s input, and previous context. You can write your own responses for this role, further aiding the model to give desired responses.

Examples:

Quick Recap:

System guides the behavior of the assistant, ensuring that responses align with the desired style, tone, and functionality.

User drives the conversation forward by providing prompts that the assistant needs to respond to.

Assistant delivers the responses based on context, fulfilling the user’s requests while adhering to the guidelines set by the system.

Examples

Without prompt engineering:

After entry submission:

With prompt engineering:

After entry submission:

Note how our preset messages influenced the output of the final result?

Known Limitations

• The OpenAI Connection can generate live results; however, it does not support creating chatbots.
• When using Assistants, function calling is not currently supported.
• OpenAI model limitations.
  • Moderations: low support for non-English languages.
  • Audio (Text-to-speech): current voices are optimized for English.

Translations

You can use the free Loco Translate plugin to create translations for any of our products. If you’ve never used Loco translate before, here’s a tutorial written for beginners.

OpenAI Billing Disclaimer

When using the OpenAI Connection, which connects Gravity Forms with the OpenAI Platform, you are responsible for managing the OpenAI API keys and associated billing.

We strongly recommend the following:

1. Require authentication to view a form that is connected to OpenAI
   One of the easiest ways to keep costs down is to prevent public access on your form. Consider requiring a log in, vetting visitors with a solution such as Submit a Gravity Form to Access Content, or providing a URL to a form in a follow-up email notification.
2. Limit the number of times a form can be submitted
   Consider solutions such as GF Limit Submissions to limit the number of times a form can be submitted for a user.
3. Leverage the “Maximum Tokens” setting
   To prevent OpenAI models from sending large replies (prompted or unprompted), utilize the “Maximum Tokens” setting in feeds and the OpenAI Stream field settings to limit the number of tokens that can be sent back.
4. Evaluate models for not only accuracy and performance, but cost
   Instead of picking the latest and great model, consider choosing cheaper models. For example, as of late August 2024, gpt-4o is $5 per 1,000,000 input tokens and $15 per 1,000,000 output tokens while gpt-4o-mini is $0.150 and $0.60 respectively. See OpenAI’s pricing for up-to-date information.
5. Set a budget in OpenAI
   We strongly encourage you to set up a budget within the OpenAI Platform. This budget will help manage costs by rejecting API requests once the budget is exceeded. Please be aware that there may be a delay in enforcing these limits, and any overage incurred will still be the responsibility of the account holder.
6. Set email notifications thresholds
   Much like budgets, you can set email notification thresholds where OpenAI can send you an email after you’ve reached a set threshold.
7. Monitor Usage and Test Integration Costs
   Before fully deploying your form, test the form and monitor usage on the OpenAI Platform to understand the potential costs associated with different API requests. Keep in mind that usage information might be delayed.
8. Use Project API keys
   With Project API keys, you can more easily track and set billing limits for specific sites using the OpenAI Connection. More importantly, it allows you to quickly revoke a key without affecting other sites if the need arises.

See OpenAI’s production best practices for more details.

FAQs

How much does the OpenAI service cost?

OpenAI is very affordable but pricing varies widely depending on the model used. Full pricing details here.

Please note that your OpenAI balance is your own responsibility. We have several suggestions on how to mitigate unexpected overages in our OpenAI Billing Disclaimer.

Why isn’t my OpenAI Stream field streaming the content?

If you are experiencing streaming responses coming all at once or in large chunks, your site’s web server config will likely need to be adjusted to support Server-sent events sent from PHP.

For sites using nginx with PHP-FPM, it’s recommended that you ensure that X-Accel-Buffering is passed using fastcgi_pass_header.

If this does not work or is out of your control, please contact your host. Configurations vary widely and they should know best.

I need some inspiration… what can I do with OpenAI?

We’ve written a series of articles focused on leveraging AI inside Gravity Forms with an emphasis on practical, real world use cases. While these articles are focused on our free plugin, you’ll find you can accomplish all of these results and far more with the premium OpenAI Connection.

• 5 ways you can use Gravity Forms OpenAI right now
• Sentiment analysis using Gravity Forms OpenAI
• How to use Gravity Forms OpenAI for content moderation
• Working with AI-generated content in Gravity Forms
• How to build a content editor with Gravity Forms OpenAI

OpenAI also has an amazing list of examples here. If that doesn’t whet your whistle, try asking ChatGPT itself. You’ll be surprised with how clever it can be!

Hooks

No posts found.