Giter VIP home page Giter VIP logo

openai-api-unreal's Introduction

OpenAI API Plugin

The OpenAIApi Plugin gives you access to the OpenAI API in Unreal Engine. It is compatible with 4.26, 4.27, 5.0, and 5.1

This is a community Plugin. No affiliation with OpenAI

Installation

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

Quick Start

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 using DALL·E 2.
Transcribe speech in any language using Whisper v2-large.
Use the chat endpoint to power an NPC with GPT-4 and GPT-3.5-Turbo.

Types of Authentication

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.

Blueprint Nodes

OpenAI Call Completions

  • This async node sends an HTTP request using your engine, prompt, and settings.

NOTE: Async nodes can only be called from a blueprint's Event Graph.

Make Completion Settings

  • 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

Break Completion

  • This node is used to access the values included in a completion or choice

Usage

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.

References

Supported Platforms

Windows, Mac, Android

openai-api-unreal's People

Contributors

kellanm avatar diamondkneeplate avatar kellaniopi avatar modestgoblin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.