OpenAI Unity

Проверьте NeoCortex для легкой интеграции NPC!

Openai Unity Package

Неофициальный пакет единства, который позволяет вам использовать API OpenAI непосредственно в игровом двигателе Unity.

Как использовать

Учебники YouTube

Вы можете найти выделенные видеоуроки для использования этого пакета в этом плейлисте YouTube.

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

Импорт пакета

Чтобы импортировать пакет, выполните следующие действия:

• Open Unity 2019 или позже
• Перейти в Window > Package Manager
• Нажмите кнопку + и выберите Add package from git URL
• Вставьте URL репозитория https://github.com/srcnalt/openai-unity.git и нажмите « Add

Настройка учетной записи Openai

Чтобы использовать API OpenAI, вам нужно иметь аккаунт OpenAI. Следуйте этим шагам, чтобы создать учетную запись и создать ключ API:

• Зайдите на https://openai.com/api и зарегистрируйтесь на учетную запись
• После того, как вы создали учетную запись, перейдите по адресу https://beta.openai.com/account/api-keys
• Создайте новый секретный ключ и сохраните его

Сохранение ваших полномочий

Чтобы сделать запросы в API OpenAI, вам необходимо использовать свой ключ API и имя организации (если применимо). Чтобы избежать разоблачения ключа API в вашем проекте Unity, вы можете сохранить его в локальном хранилище вашего устройства.

Для этого следуйте этим шагам:

• Создайте папку с названием .Openai в вашем домашнем каталоге (например, C:UserUserName для windows или ~ for linux или mac)
• Создайте файл с названием auth.json в папке .openai
• Добавьте поле API_KEY и поле организации (если применимо) в файл auth.json и сохранить его
• Вот пример того, как должен выглядеть ваш файл Auth.json:

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

Вы также можете передать свой ключ API в CTOR OpenAIApi при создании его экземпляра, но опять же, это не рекомендуется!

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

Важно: ваш ключ API - секрет. Не делитесь им с другими и не подвергайте его ни в любом коде клиента (например, браузеры, приложения). Если вы используете OpenAI для производства, обязательно запустите его на стороне сервера, где ваш ключ API может быть надежно загружен из переменной среды или службы управления ключами.

Выполнение запросов на OpenAPI

Вы можете использовать класс OpenAIApi , чтобы сделать асинхронные запросы в API OpenAI.

Все методы являются асинхронными и могут быть доступны непосредственно из экземпляра класса OpenAIApi .

Вот пример того, как сделать запрос:

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

Чтобы сделать запрос потока, вы можете использовать методы CreateCompletionAsync и CreateChatCompletionAsync . Эти методы будут устанавливать свойство Stream запроса на true и возвращать ответы через обратный вызов On -ответа. В этом случае текстовые ответы хранятся в Delta Property поля Choices в завершении чата.

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

Образец проектов

Этот пакет включает в себя две примеры сцены, которые вы можете импортировать через диспетчер пакетов:

• Пример CHATGPT: простой пример чата.
• Образец Dalle: Dall.e текст к генерации изображения.

Известные проблемы

• Невозможно увидеть результат изображения в сборках WebGL: из -за политики CORS в складке изображений OpenAI в локальных сборках WebGL вы получите URL -адрес сгенерированного изображения, однако его не будут загружены с использованием UnityWebRequest, пока вы не запустите его из LocalHost на сервере.

• Потоковой ответ просто пуст в Build Webgl: Unity 2020 Webgl имеет ошибку, когда ответы потока возвращаются пустыми. Вы можете обновить и попробовать с более новой версией Unity.

Поддерживаемые версии Unity для Builds WebGL

В следующей таблице показаны поддерживаемые версии Unity для Builds WebGL:

Версия единства	Окна	Linux	MacOS	Webgl	Android	Ios	Oculus 2
2022.3.x	✅	️	️	️	✅	✅	✅
2021.3.x	✅	️	️	️	✅	✅	✅
2020.3.x	✅	️	️	️	✅	✅	✅
2019.4.x	✅	️	️	️	️	️	️

✅ = поддерживается	️ = Не тестируется	⛔ = не поддерживается

Пожалуйста, сообщите о любых вопросах, с которыми вы сталкиваетесь со сборками.

Дальнейшее чтение

Для получения дополнительной информации о том, как использовать различные параметры запроса, пожалуйста, см.