OpenAI API 插件

OpenAIApi 插件使您能够在 Unreal Engine 中访问 OpenAI API。它兼容 4.26、4.27、5.0、5.1、5.2 和 5.3 版本。

这是一个社区插件，与 OpenAI 无任何关联。

安装

推荐的安装方式是使用预编译的二进制文件。

• 从 这里 下载插件。
• 在您的项目文件夹下创建一个 Plugins 文件夹。
• 将插件复制到该文件夹中，路径应为 YourProject/Plugins/OpenAIAPI。

快速入门

请观看 视频。

注意：本教程已过时。我们即将更新它，以展示如何使用此插件：
在运行时使用 DALL·E 2 生成图像。
使用 Whisper v2-large 转录任何语言的语音。
利用聊天端点，通过 GPT-4 和 GPT-3.5-Turbo 为 NPC 提供智能支持。

认证方式

设置 API 密钥有两种方法：

• 直接在蓝图中分配 API 密钥。
• 将 API 密钥设置为环境变量。

建议：请注意安全性，并在打包前加密您的资源。

建议：创建名为 OPENAI_API_KEY 的环境变量，并将其值设置为您的 API 密钥。

蓝图节点

OpenAI 调用补全

• 此异步节点会使用您的 引擎、提示 和 设置 发送 HTTP 请求。

注意：异步节点只能从蓝图的 事件图表 中调用。

创建补全设置

• 该节点允许您设置 请求体 参数。

注意：额外参数 起始序列 会在您的提示开头注入文本。

流式传输 功能将很快支持。

分解补全

• 该节点用于访问 补全 或 选择 中包含的值。

使用示例

以下示例展示了在蓝图中使用 OpenAI 的补全端点（GPT-3）。

以下示例展示了如何在蓝图中使用 OpenAI 的聊天端点（GPT-4 / GPT-3.5-Turbo）。

以下示例展示了如何在蓝图中使用 DALL·E 2 生成 1024x1024 的图像。

以下示例展示了如何在蓝图中使用 Whisper v2-Large 录制并转录音频。

参考资料

• OpenAI API 引擎文档
• OpenAI API 参考

支持平台

Windows、Mac、Android

OpenAI-Api-Unreal 快速上手指南

环境准备

• 引擎版本：支持 Unreal Engine 4.26, 4.27, 5.0, 5.1, 5.2, 5.3。
• 操作系统：Windows, Mac, Android。
• 前置依赖：
  • 有效的 OpenAI API Key。
  • 无需额外编译，推荐使用预构建的二进制文件。

安装步骤

本插件推荐通过下载预构建包进行安装，具体步骤如下：

1. 下载插件 访问官方提供的 Google Drive 链接下载插件压缩包： 下载链接

2. 创建目录 在你的 Unreal 项目根目录下创建一个名为 Plugins 的文件夹（如果尚未存在）： YourProject/Plugins

3. 部署文件 将下载的插件文件夹解压并复制到上述目录中，确保最终路径结构为： YourProject/Plugins/OpenAIAPI

4. 重启引擎 重新启动 Unreal Editor，插件将自动加载。

基本使用

1. 配置 API Key (身份验证)

有两种方式设置 API Key，请根据安全性需求选择：

• 方式 A：环境变量（推荐，更安全） 在系统环境中创建变量 OPENAI_API_KEY，并将你的 Key 作为值填入。

  # Windows PowerShell 示例
  $env:OPENAI_API_KEY="sk-..."
  

  注意：打包发布前请务必加密资产或使用环境变量，避免 Key 泄露。

• 方式 B：直接在蓝图中赋值 在蓝图脚本中直接将 API Key 字符串赋值给相关节点输入引脚。

2. 蓝图节点概览

在蓝图编辑器中搜索以下关键节点即可开始使用：

• OpenAI Call Completions: 异步节点，用于发送 HTTP 请求（需在 Event Graph 中调用）。
• Make Completion Settings: 设置请求参数（如 engine, prompt, temperature 等）。
  • 提示：Start Sequence 参数可用于在提示词前注入文本。
• Break Completion: 解析返回结果，获取 completion 或 choice 中的具体内容。

3. 最简单使用示例 (文本生成)

以下流程展示如何调用 GPT-3 完成简单的文本生成：

1. 在 Event BeginPlay 后连接 OpenAI Call Completions 节点。
2. 连接一个 Make Completion Settings 节点到 Settings 输入端：
   • Engine: 填写模型名称 (例如 text-davinci-003)。
   • Prompt: 填写你的提示词 (例如 "Say hello in Chinese").
3. 从 On Complete 输出引脚连接 Break Completion 节点。
4. 从 Break 节点中提取 Text 字段，并将其打印到屏幕 (Print String) 以查看结果。

进阶功能提示：该插件同样支持通过类似的蓝图逻辑调用 GPT-4/GPT-3.5-Turbo (Chat 端点)、DALL·E 2 (生成图片) 以及 Whisper (语音转文字)。