OpenAI Unity

查看NeoCortex，以获取简单的智能NPC集成！

Openai Unity包

一个非正式的统一软件包，可让您直接在Unity游戏引擎中使用OpenAI API。

如何使用

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帐户

要使用OpenAI API，您需要拥有一个OpenAI帐户。请按照以下步骤创建一个帐户并生成API密钥：

• 访问https://openai.com/api并注册帐户
• 创建帐户后，请访问https://beta.openai.com/account/api-keys
• 创建一个新的秘密键并保存

保存您的凭据

要向OpenAI API提出请求，您需要使用API​​密钥和组织名称（如果适用）。为了避免在Unity项目中暴露您的API密钥，您可以将其保存在设备的本地存储中。

为此，请执行以下步骤：

• 在您的主目录中创建一个名为.openai的文件夹（例如C:UserUserName for Windows或~ for Linux或Mac）
• 在.openai文件夹中创建一个名为auth.json的文件
• 将API_KEY字段和组织字段（如果适用）添加到auth.json文件并保存
• 这是您的auth.json文件的样子的示例：

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

创建实例时，您也可以将API键传递到OpenAIApi CTOR中，但是再次不建议这样做！

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

重要的是：您的API密钥是一个秘密。请勿与他人共享，也不要在任何客户端代码（例如浏览器，应用程序）中公开它。如果您使用OpenAI进行生产，请确保在服务器端运行它，其中可以从环境变量或密钥管理服务中牢固地加载API密钥。

向OpenAPI提出请求

您可以使用OpenAIApi类向OpenAI API提出异步请求。

所有方法都是异步的，可以直接从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方法。这些方法将通过OnResponse回调将请求的Stream属性设置为true和返回响应。在这种情况下，文本响应存储在聊天完成中Choices字段的Delta属性中。

 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样本：一个简单的chatgpt，例如聊天示例。
• Dalle样本： dall.e文本到图像生成示例。

已知问题

• 看不到WebGL构建中的图像结果：由于Local WebGL构建中OpenAI映像存储的CORS策略，您将获得生成的映像的URL，但是直到您将其从服务器上的Localhost运行，它将使用Unitywebrequest下载。

• 流中的响应只是WebGL构建中的空白： Unity 2020 WebGL具有一个错误，其中流响应返回空。您可以更新并尝试使用较新版本的Unity。

支持WebGL构建的统一版本

下表显示了WebGL构建的支持的统一版本：

Unity版本	视窗	Linux	macos	WebGl	安卓	ios	Oculus 2
2022.3.x	✅	配x	配x	配x	✅	✅	✅
2021.3.x	✅	配x	配x	配x	✅	✅	✅
2020.3.x	✅	配x	配x	配x	✅	✅	✅
2019.4.x	✅	配x	配x	配x	配x	配x	配x

✅=支持	配x =未测试	⛔=不支持

请报告您遇到的任何构建问题。

进一步阅读

有关如何使用各种请求参数的更多信息，请参阅OpenAI文档：https：//platform.openai.com/docs/api-reference