The OpenAIApi Plugin gives you access to the OpenAI API in Unreal Engine. It is compatible with 4.26, 4.27, 5.0, 5.1, 5.2, and 5.3
This is a community Plugin. No affiliation with OpenAI
This fork add modifications to support locally running LLMs with OpenAI api compatible endpoints. Use SetOpenAIAPIEndpoint
function before calling other functions to use that endpoint URL instead of the default OpenAI one.
Also adds streaming implementation for ChatAPI allowing per-token update instead of waiting for full text.
The recommended way to install the plugin is to use pre-built binaries.
- Download the Plugin here
- Create a
Plugins
folder under your project folder - Copy the plugin to it, so you have
YourProject/Plugins/OpenAIAPI
See Video
NOTE: This tutorial is out of date. Updating it soon to show how you can use this plugin to:
Generate images at runtime usingDALL·E 2
.
Transcribe speech in any language usingWhisper v2-large
.
Use the chat endpoint to power an NPC withGPT-4
andGPT-3.5-Turbo
.
There are two ways to set the Api Key
-
Assign the Api key directly in blueprints.
-
Set the Api Key as an environment variable
ADVICE: Pay attention to security and encrypt your assets before packaging.
ADVICE: Create the environment variable
OPENAI_API_KEY
and use your Api key as the value.
- This async node sends an HTTP request using your
engine
,prompt
, andsettings
.
NOTE: Async nodes can only be called from a blueprint's
Event Graph
.
- This node allows you to set the
Request body
parameters.
NOTE: The extra parameter
Start Sequence
injects text at the beginning of your prompt.
stream
will be supported soon
- This node is used to access the values included in a
completion
orchoice
This example shows OpenAI's OpenAI's completions endpoint in blueprints. (GPT-3)
This example show you how to use OpenAI's chat endpoint in blueprints. (GPT-4 / GPT-3.5-Turbo)
This example shows you how to generate a 1024x1024 image using DALL·E 2 in blueprints.
This example shows you how to record and transcribe speech using Whisper v2-Large in blueprints.
Windows, Mac, Android