功能地图

根据用例，查找适合你任何开发目标的 Convai Unity SDK 功能、模块、指南或参考页面。

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

快速上手

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

身份验证

我想……	功能	文档
比较 API 密钥和 Auth Token 身份验证模式	身份验证	身份验证
了解一个 ConvaiManager 如何解析凭据	身份验证概念	身份验证如何工作
在 API 密钥和 Auth Token 模式之间切换项目	身份验证模式设置	配置 Auth Token 模式
使用短期有效的 Auth Token 连接房间会话	Auth Token 连接	使用 Auth Token 连接
提供我自己的 Auth Token 签发逻辑	自定义令牌提供程序	自定义令牌提供程序
在不暴露我的账户 API 密钥的情况下发布玩家构建版本	安全构建	发布安全构建
从 C# 调用身份验证 API	脚本参考	身份验证脚本参考

功能

我想……	功能	文档
让我的角色执行场景内命令（触发动画、打开门、移动对象）	动作	动作
将运行时状态或事件注入角色知识	动态上下文	动态上下文
让角色自动读取有关场景对象的信息	场景元数据	场景元数据
让 AI 响应驱动角色的面部情绪显示	情绪	情绪
让角色在不同会话之间记住玩家	长期记忆	长期记忆
构建由对话触发的分支故事段落	叙事设计	叙事设计
通过摄像头或网络摄像头赋予我的角色视觉能力	视觉	视觉
决定玩家正在与哪个角色对话	对话目标定位	对话目标定位
了解玩家当前是否可以说话，并据此为我的 UI 设置门控	对话可用性	对话可用性

具身化

我想……	模块	文档
让我的角色看向玩家、物体或场景周围	注视	注视
根据对话阶段调整角色行为的时机	对话流程	对话流程
在多个角色之间共享一组行为设置	预设	具身化预设
决定说话时面部表情和口型同步分别由多少程度控制	面部组合	面部组合
通过代码驱动待机、说话、移动和手势动画	身体动画	身体动画
直接控制对话中的非语言行为——姿势、呼吸、倾听	肢体语言	肢体语言

UI 与呈现

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

核心概念

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

脚本参考

我想……	API	文档
订阅会话连接 / 断开连接 / 错误事件	会话事件	会话事件
订阅转录、情绪和轮次事件	角色事件	角色事件
在运行时读取并清除转录历史	转录 API	转录 API
使用 ConvaiSDK 和 ConvaiAudio 静态门面	对话门面	ConvaiManager API
了解 IConvaiOperation<T> 和异步模式	异步模式	异步模式
使用 ConvaiCharacter 和 ConvaiPlayer API 表面	角色和玩家 API	角色和玩家 API
了解 IConvaiOperation<T> 以及流结果类型	操作和流类型	操作与流类型

兼容性和要求

我想……	要求	文档
检查 Unity 版本、渲染管线和包要求	兼容性概览	兼容性和要求
确认支持哪些 Unity 版本和渲染管线	Unity 和渲染管线支持	Unity 版本和渲染管线
确认 SDK 所需的域名、端口和防火墙规则	网络要求	网络和 API 要求

故障排查

我想……	工具	文档
找出角色无法工作的原因，并在每个问题旁边给出修复方法	Convai 故障排查器	故障排查

平台指南

我想……	平台	文档
使用 WebGL 发布到浏览器	WebGL	WebGL
发布到 Android 或 iOS	移动端	移动端——iOS 和 Android
发布到 Windows、macOS 或 Linux	桌面端	Windows、macOS 和 Linux
通过透视视觉将内容发布到 Meta Quest	Meta Quest / XR	Meta Quest 和 XR
将 Meta Quest 透视摄像头流传输给角色	Meta Quest / XR	Meta Quest 视觉设置

高级主题

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

后续步骤

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

快速开始