com.openai.unity

OpenAI Unity 项目介绍

概述

com.openai.unity 是一个为 Unity 提供的非官方 OpenAI API 库。这个项目通过 RESTful API 让开发者在 Unity 中轻松集成 OpenAI 的功能。需要特别注意的是，该项目乃独立开发，并不是 OpenAI 的官方库。使用此库需要一个有效的 OpenAI API 账户。

安装

要使用 com.openai.unity，需要 Unity 2021.3 LTS 或更高版本。推荐的安装方法通过 Unity 的 Package Manager 和 OpenUPM。

使用 Unity Package Manager 和 OpenUPM 安装

1. 打开 Unity 项目设置。
2. 添加 OpenUPM 包注册表：
   • 名称为：OpenUPM
   • URL: https://package.openupm.com
   • 范围（Scope）：
     • com.openai
     • com.utilities
3. 打开 Unity Package Manager 窗口，将“Registry”更改为“我的 Registries”。
4. 添加 OpenAI 包。

使用 Unity Package Manager 和 Git URL 安装

也可以通过 Git URL 安装包：

• 通过 Unity Package Manager 添加包，使用以下 Git URL: https://github.com/RageAgainstThePixel/com.openai.unity.git#upm
  • 需要手动添加以下依赖库：
    • com.utilities.async
    • com.utilities.extensions
    • com.utilities.rest
    • com.utilities.audio
    • com.utilities.encoder.wav
    • com.utilities.encoder.ogg

认证

在使用 API 时，用户有四种方法提供 API 密钥，建议使用系统环境变量来加载 API 密钥以避免将它硬编码到源代码中，这对于生产环境尤为重要。

功能概述

模型使用

提供了对 OpenAI 各种模型的访问和管理功能，包括列出当前可用模型、检索模型信息以及删除调优的模型。

var api = new OpenAIClient();
var models = await api.ModelsEndpoint.GetModelsAsync();

foreach (var model in models)
{
    Debug.Log(model.ToString());
}

助手功能

用户可以创建和管理助手，并允许其调用模型和使用工具来执行特定任务。这部分功能仍处于 Beta 阶段。

聊天和消息

允许创建线程和消息，以及执行消息的发送、检索、修改等一系列操作。用户可以实现流式处理，以便及时接收和处理事件。

线程和运行

用户可以创建执行线程，管理线程的运行状态，并能对其进行修改或取消。线程运行过程中还可以接入工具来协助完成特定任务。

矢量存储

提供了矢量存储功能，用于存储文件以供工具搜索。支持对矢量存储及其中的文件进行创建、检索、修改和删除等操作。

嵌入和审核

可以创建嵌入以用于特定应用场景，还可以使用审核功能帮助管理内容审核。

代理和安全

为了避免在前端应用中暴露 API 密钥，建议设置一个中间 API 来代替前端应用向 OpenAI 发送请求，从而保证通信的安全性。

总之，com.openai.unity 为 Unity 环境中的开发者提供了一种便捷的方式来集成 OpenAI 的强大功能，通过本库用户可以访问多种 API 端点，从模型操作到消息传递，无不覆盖。