OpenAI

Based on OpenAI-DotNet

A OpenAI package for the Unity to use though their RESTful API. Independently developed, this is not an official library and I am not affiliated with OpenAI. An OpenAI API account is required.

All copyrights, trademarks, logos, and assets are the property of their respective owners.

Installing

Requires Unity 2021.3 LTS or higher.

The recommended installation method is though the unity package manager and OpenUPM.

Via Unity Package Manager and OpenUPM

Terminal

openupm add com.openai.unity

Manual

• Open your Unity project settings
• Add the OpenUPM package registry:
  • Name: OpenUPM
  • URL: https://package.openupm.com
  • Scope(s):
    • com.openai
    • com.utilities

• Open the Unity Package Manager window
• Change the Registry from Unity to My Registries
• Add the OpenAI package

Via Unity Package Manager and Git url

[!WARNING] This repo has dependencies on other repositories! You are responsible for adding these on your own.

• Open your Unity Package Manager
• Add package from git url: https://github.com/RageAgainstThePixel/com.openai.unity.git#upm
  • com.utilities.async
  • com.utilities.websockets
  • com.utilities.extensions
  • com.utilities.rest
  • com.utilities.audio
  • com.utilities.encoder.wav

---

Documentation

Check out our new api docs!

https://rageagainstthepixel.github.io/OpenAI-DotNet

Table of Contents

• Authentication
• Azure OpenAI
  • Azure Active Directory Authentication
• OpenAI API Proxy
• Models
  • List Models
  • Retrieve Models
  • Delete Fine Tuned Model
• Responses
  • Create Response
    • Simple Text Response
    • Streaming Response with Function Calling
  • Get Response
  • List Input Items
  • Cancel Response
  • Delete Response
• Conversations
  • Create Conversation
  • Retrieve Conversation
  • Update Conversation
  • Delete Conversation
  • List Conversation Items
  • Create Conversation Item
  • Retrieve Conversation Item
  • Delete Conversation Item
• Realtime
  • Create Realtime Session
  • Client Events
    • Sending Client Events
  • Server Events
    • Receiving Server Events
• Assistants
  • List Assistants
  • Create Assistant
  • Retrieve Assistant
  • Modify Assistant
  • Delete Assistant
  • Assistant Streaming
  • Threads
    • Create Thread
    • Create Thread and Run
      • Streaming
    • Retrieve Thread
    • Modify Thread
    • Delete Thread
    • Thread Messages
      • List Messages
      • Create Message
      • Retrieve Message
      • Modify Message
    • Thread Runs
      • List Runs
      • Create Run
        • Streaming
      • Retrieve Run
      • Modify Run
      • Submit Tool Outputs to Run
      • Structured Outputs
      • List Run Steps
      • Retrieve Run Step
      • Cancel Run
  • Vector Stores
    • List Vector Stores
    • Create Vector Store
    • Retrieve Vector Store
    • Modify Vector Store
    • Delete Vector Store
    • Vector Store Files
      • List Vector Store Files
      • Create Vector Store File
      • Retrieve Vector Store File
      • Delete Vector Store File
    • Vector Store File Batches
      • Create Vector Store File Batch
      • Retrieve Vector Store File Batch
      • List Files In Vector Store Batch
      • Cancel Vector Store File Batch
• Chat
  • Chat Completions
  • Streaming
  • Tools
  • Vision
  • Audio
  • Structured Outputs
  • Json Mode
• Audio
  • Create Speech
    • Stream Speech
  • Create Transcription
  • Create Translation
• Images
  • Create Image
  • Edit Image
  • Create Image Variation
• Files
  • List Files
  • Upload File
  • Delete File
  • Retrieve File
  • Download File Content
• Fine Tuning
  • Create Fine Tune Job
  • List Fine Tune Jobs
  • Retrieve Fine Tune Job Info
  • Cancel Fine Tune Job
  • List Fine Tune Job Events
• Batches
  • List Batches
  • Create Batch
  • Retrieve Batch
  • Cancel Batch
• Embeddings
  • Create Embedding
• Moderations
  • Create Moderation

Authentication

There are 4 ways to provide your API keys, in order of precedence:

[!WARNING] We recommended using the environment variables to load the API key instead of having it hard coded in your source. It is not recommended use this method in production, but only for accepting user credentials, local testing and quick start scenarios.

1. Pass keys directly with constructor :warning:
2. Unity Scriptable Object :warning:
3. Load key from configuration file
4. Use System Environment Variables

You use the OpenAIAuthentication when you initialize the API as shown:

Pass keys directly with constructor

[!WARNING] We recommended using the environment variables to load the API key instead of having it hard coded in your source. It is not recommended use this method in production, but only for accepting user credentials, local testing and quick start scenarios.

var api = new OpenAIClient("sk-apiKey");

Or create a OpenAIAuthentication object manually

var api = new OpenAIClient(new OpenAIAuthentication("sk-apiKey", "org-yourOrganizationId", "proj_yourProjectId"));

Unity Scriptable Object

You can save the key directly into a scriptable object that is located in the Assets/Resources folder.

You can create a new one by using the context menu of the project pane and creating a new OpenAIConfiguration scriptable object.

[!WARNING] Beware checking this file into source control, as other people will be able to see your API key. It is recommended to use the OpenAI-DotNet-Proxy and authenticate users with your preferred OAuth provider.

Load key from configuration file

Attempts to load api keys from a configuration file, by default .openai in the current directory, optionally