OpenAI Unity

Consultez Neocortex pour une intégration Smart NPC facile!

Openai Unity Package

Un package d'unité non officiel qui vous permet d'utiliser l'API OpenAI directement dans le moteur Unity Game.

Comment utiliser

Tutoriels YouTube

Vous pouvez trouver des tutoriels vidéo dédiés pour utiliser ce package dans cette liste de lecture YouTube.

https://www.youtube.com/playlist?list=plre-fzieels1-c7qifzyzeq50id08fcjo

Importation du package

Pour importer le package, suivez ces étapes:

• Open Unity 2019 ou plus tard
• Go to Window > Package Manager
• Click the + button and select Add package from git URL
• Paste the repository URL https://github.com/srcnalt/OpenAI-Unity.git and click Add

Configuration de votre compte Openai

Pour utiliser l'API OpenAI, vous devez avoir un compte OpenAI. Suivez ces étapes pour créer un compte et générer une clé API:

• Allez sur https://openai.com/api et inscrivez-vous à un compte
• Une fois que vous avez créé un compte, rendez-vous sur https://beta.openai.com/account/api-Keys
• Créez une nouvelle clé secrète et enregistrez-la

Sauver vos informations d'identification

Pour faire des demandes à l'API OpenAI, vous devez utiliser votre clé API et le nom de votre organisation (le cas échéant). Pour éviter d'exposer votre clé API dans votre projet Unity, vous pouvez l'enregistrer dans le stockage local de votre appareil.

Pour ce faire, suivez ces étapes:

• Create a folder called .openai in your home directory (eg C:UserUserName for Windows or ~ for Linux or Mac)
• Create a file called auth.json in the .openai folder
• Ajoutez un champ API_KEY et un champ d'organisation (le cas échéant) au fichier auth.json et enregistrez-le
• Voici un exemple de ce à quoi devrait ressembler votre fichier auth.json:

{
    "api_key" : " sk-...W6yi " ,
    "organization" : " org-...L7W "
}

You can also pass your API key into OpenAIApi ctor when creating an instance of it but again, this is not recommended!

 var openai = new OpenAIApi ( " sk-Me8...6yi " ) ;

IMPORTANT: Your API key is a secret. Ne le partagez pas avec d'autres et ne l'exposez pas dans un code côté client (par exemple, navigateurs, applications). Si vous utilisez OpenAI pour la production, assurez-vous de l'exécuter du côté du serveur, où votre clé API peut être en toute sécurité à partir d'une variable d'environnement ou d'un service de gestion de clé.

Faire des demandes à OpenAPI

You can use the OpenAIApi class to make async requests to the OpenAI API.

All methods are asynchronous and can be accessed directly from an instance of the OpenAIApi class.

Voici un exemple de la façon de faire une demande:

 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 ) ;
}

To make a stream request, you can use the CreateCompletionAsync and CreateChatCompletionAsync methods. These methods are going to set Stream property of the request to true and return responses through an onResponse callback. In this case text responses are stored in Delta property of the Choices field in the Chat Completion.

 var req = new CreateChatCompletionRequest {
    Model = " gpt-3.5-turbo " ,
    Messages = new List < ChatMessage >
    {
        new ChatMessage ( )
        {
            Role = " user " ,
            Content = " Write a 100 word long short story in La Fontaine style. "
        }
    } ,
    Temperature = 0.7f ,
} ;
    
openai . CreateChatCompletionAsync ( req , 
    ( responses ) => {
        var result = string . Join ( " " , responses . Select ( response => response . Choices [ 0 ] . Delta . Content ) ) ;
        Debug . Log ( result ) ;
    } , 
    ( ) => {
        Debug . Log ( " completed " ) ;
    } , 
    new CancellationTokenSource ( )
) ;

Échantillons de projets

Ce package comprend deux exemples de scènes que vous pouvez importer via le gestionnaire de packages:

• ChatGPT sample: A simple ChatGPT like chat example.
• DallE sample: A DALL.E text to image generation example.

Problèmes connus

• Can't See the Image Result in WebGL Builds: Due to CORS policy of OpenAI image storage in local WebGL builds you will get the generated image's URL however it will not be downloaded using UnityWebRequest until you run it out of localhost, on a server.

• Streamed Response is just blank in WebGL Build: Unity 2020 WebGL has a bug where stream responses return empty. Vous pouvez mettre à jour et essayer avec une version plus récente d'Unity.

Versions d'unité prise en charge pour les constructions WebGl

Le tableau suivant montre les versions d'unité prise en charge pour les versions WebGL:

Version d'unité	Fenêtre	Linux	Macos	Webgl	Androïde	Ios	Oculus 2
2022.3.x	✅	️	️	️	✅	✅	✅
2021.3.x	✅	️	️	️	✅	✅	✅
2020.3.x	✅	️	️	️	✅	✅	✅
2019.4.x	✅	️	️	️	️	️	️

✅ = pris en charge	️ = Non testé	⛔ = non pris en charge

Veuillez signaler tous les problèmes que vous rencontrez avec les builds.

Dès la lecture

Pour plus d'informations sur la façon d'utiliser les différents paramètres de demande, veuillez vous référer à la documentation OpenAI: https://platform.openai.com/docs/api-reference