配置 API 密钥

在 SDK 设置中输入你的 Convai API 密钥，以验证项目并启用角色通信。

Unity 版 Convai SDK 使用与您的 Convai 账户关联的 API 密钥对每个会话进行身份验证。您只需在 Unity 编辑器中输入一次该密钥——它会保存在您的项目中，并在运行时自动使用。

1

复制您的 API 密钥

登录到您的 Convai 控制面板，网址为 convai.com，然后导航到 账户设置，并复制您的 API 密钥。

2

打开 Convai 配置窗口

在 Unity 编辑器菜单栏中，打开 Convai > 账户.

Convai 配置窗口会打开到“账户”部分。

3

粘贴 API 密钥

将您的 API 密钥粘贴到 API 密钥 字段中。

该密钥会立即保存到 Assets/Resources/ConvaiSettings.asset。无需额外的保存步骤。

4

验证密钥是否被接受

运行 GameObject > Convai > Validate Scene Setup。缺少 API 密钥会在验证器对话框中显示为警告。如果没有出现 API 密钥警告，则说明您的密钥配置正确。

Assets/Resources/ConvaiSettings.asset 会将 API 密钥以明文形式存储。如果您的项目使用源代码管理，请根据团队的安全策略决定是否提交此文件。

密钥在运行时的使用方式

SDK 会从 ConvaiSettings 通过 ICredentialProvider 接口读取密钥，然后再发起任何与 Convai 的连接。您无需在代码中手动传递密钥——SDK 会在启动时自动解析它。

对于不允许将密钥存储在源代码管理中的生产部署，请实现一个自定义的 ICredentialProvider ，以便从安全来源读取密钥。

自定义凭据提供程序

下一步

在放置好 API 密钥后，先导入一个示例场景，以验证 SDK 正常工作，然后再构建您自己的场景。

导入并运行示例场景