功能地图

按用例索引，找到适合任何开发目标的 Convai Unity SDK 功能、模块、指南或参考页面。

当你知道自己想要的结果，但不确定哪个 SDK 功能、模块或指南涵盖它时，请使用此表。

入门

我想……	功能 / 工具	文档
将 SDK 安装到我的项目中	安装	安装
配置我的 Convai API 密钥	API 密钥设置	配置 API 密钥
将我的第一个对话角色添加到场景中	场景设置	构建自定义场景
无需从头构建即可运行一个可用示例	示例场景	导入并运行示例场景
了解场景中每个组件的作用	组件参考	场景组件参考
在按住说话和免提输入之间选择	输入模式	配置对话输入模式
配置角色音频输出	音频设置	配置角色音频
配置麦克风设备和平台权限	音频设置	配置麦克风
添加聊天或字幕转录显示	转录 UI	添加聊天 UI
为我的角色添加实时口型同步	口型同步	添加口型同步
在发布前验证我的场景是否设置正确	场景验证器	验证你的设置

功能

我想……	功能	文档
让我的角色执行场景内命令（触发动画、打开门、移动物体）	动作	动作
将运行时状态或事件注入角色的知识中	动态上下文	动态上下文
让角色自动读取有关场景对象的信息	场景元数据	场景元数据
根据 AI 响应在我的角色上显示面部情绪	情绪	情绪
让角色在不同会话之间记住玩家	长期记忆	长期记忆
构建由对话触发的分支式故事片段	叙事设计	叙事设计
通过摄像头或网络摄像头让我的角色获得视觉能力	视觉	视觉

实用工具

我想……	实用工具	文档
为我的角色添加身体和头部对话动画	对话动画	对话动画
让我的角色看向目标、玩家或兴趣点	注视与注意力	注视与注意力

UI 与呈现

我想……	组件	文档
在我的 UI 中显示实时对话记录	转录 UI	转录 UI
在聊天和字幕显示模式之间切换	呈现模式	聊天和字幕模式
从代码中查询对话记录历史或响应对话记录变化	对话记录历史	对话记录历史与查询
显示游戏世界内通知弹窗	通知系统	通知系统
添加运行时设置面板（麦克风、转录、通知、输入）	设置面板	设置面板
从代码中读取或应用运行时设置	运行时设置	运行时设置 API
自定义 UI 组件的外观和布局	UI 自定义	自定义 UI 组件

核心概念

我想……	概念	文档
全面了解系统架构	架构	Convai Unity SDK 架构
了解会话状态、重连和持久化	会话生命周期	会话生命周期
比较免提和按住说话的轮流发言方式	轮流发言模式	轮流发言模式
从 C# 或 Inspector 订阅对话事件	事件系统	事件系统

脚本参考

我想……	API	文档
订阅会话连接 / 断开连接 / 错误事件	会话事件	会话事件
订阅转录、情绪和轮次事件	角色事件	角色事件
在运行时读取并清空对话记录历史	对话记录 API	对话记录 API
使用 ConvaiSDK 和 ConvaiAudio 静态门面	对话门面	ConvaiManager API
了解 IConvaiOperation<T> 以及异步模式	异步模式	异步模式

平台指南

我想……	平台	文档
使用 WebGL 发布到浏览器	WebGL	WebGL
发布到 Android 或 iOS	移动端	移动端 — iOS 和 Android
使用透视视觉发布到 Meta Quest	Meta Quest / XR	Meta Quest 和 XR

高级主题

我想……	主题	文档
替换 API 凭证提供程序	自定义提供程序	自定义凭证提供程序
替换终端用户身份提供程序	自定义提供程序	自定义身份提供程序
替换会话持久化提供程序	自定义提供程序	自定义持久化提供程序
测量延迟并解读会话指标	性能	性能与优化
使用自定义模块扩展 SDK 或替换内部服务	扩展点	扩展 SDK

下一步

如果你尚未设置 SDK，请从安装开始。

快速入门