OpenAI-Unity

OpenAI Unity Package: A Comprehensive Guide

The OpenAI Unity Package is an unofficial tool designed to integrate directly with the OpenAI API in the Unity game engine. This allows game developers to harness the power of OpenAI's models within their Unity projects. From producing engaging chat applications to generating stunning visuals, this package enables developers to enhance their games with advanced AI capabilities.

How to Get Started

Informative YouTube Tutorials

For those new to this package, a series of YouTube tutorials is available to guide you through its usage. These tutorials cover everything from installation to implementation, providing a visual and straightforward learning path.

Importing the OpenAI Unity Package

To begin using the OpenAI Unity Package, follow these steps:

Ensure you have Unity 2019 or later installed.
Navigate to Window > Package Manager in Unity.
Click the + button, select Add package from git URL.
Enter the repository URL: https://github.com/srcnalt/OpenAI-Unity.git and click Add.

Setting Up Your OpenAI Account

To access the OpenAI API, an account is necessary. Here is how to set it up:

Sign up at OpenAI API and create an account.
Visit API Keys to generate a new secret key.

Securely Saving Your Credentials

Handling your API key securely is crucial to maintaining security within your project. Save credentials in your local storage:

Create a directory named .openai in your home folder (e.g., C:User\UserName\ for Windows).
Inside this folder, create a auth.json file.
Store your api_key and optionally your organization in this file like so:
```
{
    "api_key": "sk-...W6yi",
    "organization": "org-...L7W"
}
```

While you can provide the API key directly when instantiating the OpenAIApi class, it is not advisable due to security reasons. Always strive to keep your API keys confidential and secure.

Interacting with the OpenAI API

To communicate with the OpenAI API, the OpenAIApi class offers asynchronous methods for making requests. Here's a simple example:

private async void SendRequest()
{
    var req = new CreateChatCompletionRequest
    {
        Model = "gpt-3.5-turbo",
        Messages = new List<ChatMessage>()
        {
            new ChatMessage()
            {
                Role = "user",
                Content = "Hello!"
            }
        }
    };
    var res = await openai.CreateChatCompletion(req);
}

For streaming capabilities, utilize methods like CreateCompletionAsync with a callback for handling responses. This approach is optimal for real-time applications needing continuous data flow.

Exploring Sample Projects

The package provides two distinctive sample scenes:

ChatGPT Sample: Demonstrates how to create a chat application similar to ChatGPT.
DALL·E Sample: Shows how to generate images from text prompts using DALL·E.

Noteworthy Issues and Solutions

While the package is powerful, users may encounter some issues:

WebGL Image Display Issues: The OpenAI storage's CORS policy may prevent image downloads in local WebGL builds unless executed on a server.
Blank Streamed Responses: Unity 2020 WebGL has a known bug; upgrading Unity may resolve this.

Supported Unity Versions

For WebGL builds, the following versions of Unity are supported with varying degrees of reliability:

2022.3.x: Full support on most platforms.
2021.3.x through 2019.4.x: Support varies, with WebGL as not tested.

Confidence with your selected Unity version is crucial for seamless integration with the OpenAI API. Should any issues occur, feel free to report them to the project developers for assistance.