> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/overview/release-notes.md).

# 更新说明

跟踪 Convai Unity SDK 在各个版本中的变化，包括新功能、错误修复和配置更改。当前版本是 <code class="expression">space.vars.unity\_sdk\_version</code>.

{% updates format="full" %}
{% update date="2026-08-14" tags="v4.5.0,Current" %}

## v4.5.0

**角色 Embodiment**

五个行为模块现在共享一个组件系列，位于 **添加组件 > Convai > 具身**，并且每个模块都读取相同的对话状态。

* **Convai Gaze** (`ConvaiGazeController`）取代了先前的 Gaze 实现和 Attention 模块。它决定角色看向什么，并在一个组件中完成注视：目光接触样式（`自然`, `讲话聚焦`, `对话锁定`, `始终锁定`), `ConvaiGazeTarget` 用于具有优先级层级和瞄准偏移的场景对象， `PlayerAttentionSensor` 用于“玩家是否在看我”，提供从眼睛到头部、胸部再到脚部的全身注视共享阶梯，以及通过……的 XR 眼动追踪扩展点 `IPlayerGazeRaySource`
* **Convai 身体动画** (`ConvaiBodyAnimationController`）取代了 Dialogue Animation。它会构建自己分层的 `PlayableGraph` 在代码中，因此无需编写 Animator Controller 资源。它涵盖待机和说话变体、伴随语音手势、指向目标的手势，以及与 NavMesh 同步的行走，包括带方向的起步、落脚停步和原地转身。动画片段和 `ConvaiBodyAnimationSet_Female` 随模块一起提供
* **Convai 肢体语言** (`ConvaiBodyLanguageController`）是新增功能：呼吸、重心转移、摆动、姿势脉动、随语音节奏的头部点动、倾听时前倾、待机小动作，以及受惊或觉得有趣时的反应。它叠加在 Animator 之上，不占用任何片段，并且不需要导入内容
* **情绪** 新增了语义表情配方，可无须按角色单独编写即可映射到 ARKit、Reallusion CC3 和 CC4，以及 MetaHuman 绑定；还增加了静态情绪、情绪漂移、微表情待机层和着色器属性输出。 `ConvaiEmotionController.SetMood(label, intensity, transitionSeconds)` 和 `ClearMood(transitionSeconds)` 在运行时控制情绪，并且 `DominantEmotionChanged` 和 `MoodChanged` 报告已解析的表情。随附四种人格：沉着、温暖、活力和克制
* **对话流程** 提供另外四个模块读取的对话状态

**角色动作**

* 该 **Actions Editor** 窗口（**Convai > 动作编辑器**）添加可复用的动作集、场景知识、角色设置，以及带有批处理进度、时间线、目标注册表和逐动作洞察的实时模式。 **试试** 框会在编辑模式下预览动作，并在播放模式下触发该动作
* 新增四个内置执行器：引导玩家到目标、扫描环境、统计目标组和测量距离
* `ConvaiActionExecutionResult.Answered("…")` 允许动作提供一句角色可说的话，与诊断信息分开 `消息`. **完成时** 按每个动作编写此内容
* `ConvaiActionFailureReason` 在……上报告带类型的失败原因 `ConvaiActionExecutionResult` 和 `ConvaiActionStepReport`. `ConvaiActionParameterValue.Presence` 区分未填充的槽位和空白槽位。 `ConvaiActionDispatcher` 公开 `IsBusy`, `PendingBatchCount`，以及 `CurrentActionName`
* `ConvaiActionExecutorBase`, `ConvaiTargetedActionExecutor`，以及 `ConvaiCharacterActionExecutor<TPeer>` 是自定义行为的基类。 `ConvaiPlayerBody` 现在是 public，并且 `ConvaiActionExecutorBase.ResolvePlayer()` 为 `virtual`，因此移动子胶囊体的第一人称绑定会解析为玩家的真实位置
* 线缆解析已在大量丢失和乱码的命令案例中得到修正，并且场景中放置的 `上的本地专用含义相同` 现在会在会话中途与 Convai 同步

**身份验证**

* 身份验证现在是项目级选择，可在 API Key 模式和 Auth Token 模式之间切换。Auth Token 模式会从已配置的端点或一个……中获取新的短期凭证 `IConvaiAuthTokenProvider` 在每次房间连接前使用，适用于 Native 和 WebGL 传输，并在……中发送凭证 `API-AUTH-TOKEN` 标头中发送，并在保留用于编辑器工具的同时，从玩家构建中移除已保存的账户 API 密钥
* `ConvaiManager.ConnectWithAuthTokenAsync` 适用于登录层已持有 Convai auth token 的项目的一次性连接。它还提供 `end_user_id` 和 `end_user_metadata.name` 在没有已注册提供程序或已配置端点的情况下

**会话生命周期**

空闲警告和空闲截止事件， `ResetIdleTimer` 和 `ExtendIdleTimeout`并且运行时可显式使用暂停、恢复和重新连接控制。后台行为通过以下方式设置： `继续发声`, `暂停时间线`，以及 `静音但继续追赶` 策略，并提供一个可观察的 WebGL 回退，来自 `暂停时间线` 到 `静音但继续追赶`.

**编辑器工具**

* **Convai > 故障排查工具** 按角色报告每项 Convai 功能的状态：已设置、已阻止，或已设置但未生效，并提供一键修复和 **全部修复** 操作 `可通过以下方式扩展：` 和 `IConvaiSetupHealthProvider`
* 该 **Convai** 菜单已从 17 行缩减为 9 行——请参见下方的破坏性更改和迁移
* 所有 Convai 检视器和窗口都迁移到了共享的编辑器设计系统，Character Rig 检视器也被重写，首先显示“就绪”或“需要关注”的结论，以及分段式检测置信度
* 打开包随附的设置资源时为只读，并提供 **创建项目副本**，会将副本放在 `Assets/Convai/`

**要求和依赖项**

最低 Unity 版本为 `6000.0.80f1`。该包新增三个依赖项： `com.unity.ai.navigation`, `com.unity.collections`，以及 `com.unity.modules.xr`.

**LipSync、示例和平台**

* Lip Sync 示例随附 Sofia，一个 Reallusion CC4 角色，取代了 Camila
* 内置的 viseme 映射和口型同步配置文件已从 `SamplesShared/Resources/` 迁移到 LipSync 模块中，并在代码中构建。位于以下位置的项目注册表： `Resources/LipSync/ProfileRegistries/` 仍会被发现，并且仍然具有优先级
* `ConvaiLipSyncSpeechEnergyAdapter` 从未被采样，因此每个读取语音能量的功能都读到的是平坦信号。现在它加入角色 tick，并在每一帧采样
* 该包随附 `ConvaiSampleFirstPersonController` 和 `ConvaiSampleFirstPersonInputs`，这是 Unity Starter Assets 第一人称控制器的重命名副本
* Meta Quest 按键通话释放现在通过 Unity 的 XR 输入 API 读取 A、B、X 和 Y 按钮，而控制器读取失败或断开连接会安全失败，因此麦克风采集无法保持开启
* Quest Vision Frame Source 具有设计好的检视器，并带有实时捕获读数。升级后 Vision 组件的折叠状态会重置一次

**破坏性更改和迁移**

* **Unity 6000.0.80f1 是最低编辑器版本。** 低于此门槛的配置不受支持。请先升级编辑器，再升级该包
* **三个模块已被弃用，每个都有替代者。** Attention 被 Convai Gaze 取代，Dialogue Animation 被 Convai Body Animation 取代，面部片段系统被 Emotion 模块的微表情层取代。它们对应的程序集、配置文件资源和预设槽位也一并移除
* **从 Attention 或先前的 Gaze 组件迁移：** 替换 `ConvaiAttentionController`, `ConvaiGazeCoordinator`, `ConvaiHeadLookActuator`，以及 `ConvaiEyeGazeActuator` 为单个 `ConvaiGazeController` (**添加组件 > Convai > 具身 > Gaze**）。删除你的 `ConvaiAttentionProfile`, `ConvaiGazeCoordinationProfile`, `ConvaiGazeEyeProfile`，以及 `ConvaiGazeHeadProfile` 资源——这些类型已不存在，资源将无法反序列化。调优值不会迁移；请在 `ConvaiGazeProfile`上重新调优，或者不分配任何项并从默认值开始。将自定义的 `IFocusTargetProvider` 或 `IGazeIntentProvider` 和 `IGazeTargetProvider` 通过……注册的 `RegisterTargetProvider`, `ConvaiAttentionDynamicContextBridge` 和 `GazeDynamicContextBridge`，以及 `ConvaiWorldObjectFocusProvider` 和 `ConvaiGazeTarget`。请替换 `ConvaiWorldObjectFocusProvider` 在保存受影响场景之前，因为 Unity 会在下次保存时静默移除已删除的组件
* **从 Dialogue Animation 迁移：** 替换 `ConvaiDialogueAnimationController` 和 `ConvaiBodyAnimationController`，将片段从 `DialogueAnimationLibrary` 移动到 `ConvaiBodyAnimationSet`，并将时序和权重调优移动到 `ConvaiBodyAnimationConfig`。删除 `DialogueAnimatorContract` 资源、其四个 Animator 图层、乒乓状态，以及 `ConvaiDialogueSlot_*` 占位片段；若保留 Animator Controller，会与图谱争夺相同骨骼。按片段的性别筛选（`CharacterGender`）以及按片段的情绪亲和标签（`DialogueEmotionAffinity`）没有字段级迁移——请为每种角色类型分别编写一套，而不是在运行时筛选混合集合。 `AnimationRiggingGazeBridge` 已移除，而 Convai Gaze 不需要 rigging 包
* **从面部片段迁移：** 删除 `ConvaiFacialClipPlayer`, `ConvaiFacialClipRuntimePlayer`，以及它们的配置文件资源，并让 Emotion 模块的微表情层生成待机时的面部生命感——默认已开启，无需迁移任何内容。对于精心制作的面部表演，本版本没有受支持的替代方案；请自行使用 `SkinnedMeshRenderer.SetBlendShapeWeight` 来驱动一个不会被任何 Convai 模块组合的网格。在升级前请将你的片段烘焙到自己的资源中，因为 `ConvaiFacialAnimationProfile` 一旦模块移除，这些资源将无法反序列化
* **Convai 编辑器菜单已重新结构化。** **Convai > 欢迎**, **Convai > 账户**, **Convai > 长期记忆**, **Convai > 更新**, **Convai > 联系我们**，以及 **Convai > AI 编码设置** 已移除；这些部分位于再点击一次即可进入的窗口中，该窗口 **Convai > Convai Editor** 会打开。当前的九行分为三组：Convai 编辑器窗口及其设置—— **Convai > Convai Editor**, **Convai > 设置**, **Convai > 文档**；按功能划分的创作编辑器—— **Convai > 动作编辑器**, **Convai > 身体动画编辑器**, **Convai > 情绪编辑器**, **Convai > Gaze Editor**, **Convai > 具身编辑器**；以及诊断—— **Convai > 故障排查工具**。 `ConvaiConfigurationWindowEditor` 直接打开某个部分的方法仍然是 public
* **`UnityEventActionExecutor` 已重命名为 `ConvaiUnityEventActionExecutor` 并带有新的 GUID。** Unity 不会迁移该组件：它会从所有包含它的场景和 prefab 中移除，同时连同接入其中的事件一起删除，而且没有任何升级步骤可以恢复它们。升级前请记录每个事件调用了什么。随后添加 `ConvaiUnityEventActionExecutor` (**添加组件 > Convai > 动作 > 触发 Unity 事件**）到每个受影响对象上，手动重新接线其事件，并重新指向任何绑定到旧组件的动作。序列化字段仍然是 `_onExecute`
* **三个实验性的动作执行器已从公开目录中移除：** Guided Tour、Address The Group 和 Perform Gesture At Target。 `LookAtTargetActionExecutor` 也已移除——请添加 `ConvaiLookAtActionExecutor` (**添加组件 > Convai > 动作 > 注视目标**）替代，并为角色添加 Gaze，因为替代方案通过 `ConvaiGazeController`。六个示例动作行为， `ConvaiActionTestSetup`，以及 `ConvaiActionDebugWindow` 已移除；动作编辑器已覆盖它们的功能
* **Point At Target 的 `保持秒数` 仅表示动作中途暂停**，而不是整个手势的时长。现在有两个设置会影响指向层： **手势速度** 会乘以抬起和放下的速度，而 **释放** 设置为 `混合` 在保持结束时放下姿势。两者默认与先前行为一致，因此现有场景无需更改；约一秒的指向是 Gesture Speed `1.5` 配合 Release `混合`
* **现在有十四种编辑器类型 `internal`,** 其中包括 `ConvaiVisionBaseEditor`, `ConvaiCharacterEditor`，以及 `TurnTakingOptionsDrawer`。不再支持继承 Convai 编辑器或属性绘制器，也没有替代的扩展点——请删除子类，并通过单独的 `MonoBehaviour` 来自你自己的。 `[CustomEditor]` 注册不受影响，因此每个 Convai 检视器的绘制方式保持不变
* **Emotion 模块的槽位列表面部输出路径已移除：** `EmotionSlotBinding`, `BlendshapeEmotionBinding`, `AnimatorParameterEmotionBinding`, `RealisticEmotionSlots`, `NeutralAlternator`，以及 `SemanticExpressionsEnabled` 和 `NeutralAlternationEnabled` 会开启 `ConvaiEmotionProfile`。只要语义表情开启，运行时就会丢弃这些数据，而所有已发布配置文件都默认开启，因此无需迁移任何内容。着色器属性输出不受影响
* **共享的 Emotion 分类法和配置文件资源已更换标识。** `ConvaiSamplesShared_EmotionTaxonomy.asset` 已重建，并且 `ConvaiSamplesShared_EmotionProfile.asset` 已被四种命名人格取代。打开每个受影响角色，重新指向分类法和人格；没有分类法的角色仍能运行，但每个情绪下拉框都会为空
* **Embodiment 类型已重命名，资源 GUID 保持不变：** `EmbodimentProfileReceiver<T>` 到 `ConvaiCharacterModule<T>`, `CharacterEmbodimentPreset` 到 `ConvaiEmbodimentPreset`, `EmbodimentPresetLibrary` 到 `ConvaiEmbodimentPresetLibrary`，以及 `ConvaiCharacterEmbodimentBinding` 到 `ConvaiEmbodimentPresetBinding`。只需更新源代码引用。 `EmbodimentContext` 用一个成员替换了其按接缝注册的成员 `CharacterServiceRegistry` — 实现 `IEmbodimentTickable` 并调用 `EmbodimentContext.RegisterTickable(this)` 来自 `OnEnable` 以加入角色 tick。 `EmbodimentContext.TryResolve` 不再会在非 Convai 角色的 GameObject 上创建上下文；请调用 `TryResolveFor` 以获得可诊断的失败
* **`ActionResponsePayload` 以及公开的 `UnityObjectCompatibility` 类已被移除。** 动作命令仍然通过以下方式到达： `ConvaiCharacter.OnActionsReceived` 和 `ConvaiManager.Events.OnCharacterActionReceived`。请替换 `UnityObjectCompatibility.FindObjectsByType<T>(mode)` 使用 Unity 的 `Object.FindObjectsByType<T>`，以及 `UnityObjectCompatibility.GetId(value)` 和 `value.GetInstanceID()` 适用于 Unity 6000.4 及之前版本，或 `value.GetEntityId()` 在 6000.2 及更新版本上
* **Camila 示例角色已移除。** 引用其 prefab、材质或纹理的场景或 prefab 会报告缺失引用。Sofia 使用相同的 blendshape 约定，因此 Convai 设置可以迁移。升级前请将任何自定义的 Camila 资源从包中复制出去
  {% endupdate %}

{% update date="2026-07-30" tags="v4.4.1" %}

## v4.4.1

**修复**

* 为对象 ID 和对象搜索添加了 Unity 6.0 到 6.5+ 的兼容路径。Unity 6.4 及更新版本使用 64 位 `EntityId` 以及无排序搜索 API，而 Unity 6.0 到 6.3 保留旧版回退
* 通过移除不可用的伪模块依赖并固定……，修复了 Unity 6.0 项目解析 `com.unity.collections` 到 `2.6.8`，避免了已知的 Collections `2.6.7` 和 AI Assistant `xxHash3`/`Unsafe` 编译器回归问题
* 通过统一两种 URP 渲染层序列化格式，使 LipSync 示例背景光在 Unity 6.0 和 6.4+ 中保持隔离，防止灯光过度曝光示例角色
* 按键通话释放现在会在等待最终转写结果时保持麦克风和语音识别开启。当可配置的 `PushToTalkPolicy.ReleaseTailMs` 窗口到期时，SDK 会发出权威停止信号，并在关闭采集前允许另一个受限时间窗口
* 修复了 WebGL 构建因过期的 `NativeLib` 引用于 `livekit-bridge.jslib`中的引用导致崩溃的问题，并通过修正音频时序注册顺序、预热 WebGL 分析器以及恢复丢失的……，恢复了首轮 LipSync `PlaybackStarted` 回调
  {% endupdate %}

{% update date="2026-07-21" tags="v4.4.0" %}

## v4.4.0

**规范转写时间线**

`ConvaiManager.Transcripts` 现在公开一个房间范围内的 `TranscriptTimeline` 由不可变的……构建 `TranscriptTurn` 和 `TranscriptChange` 模型构建的接口，取代了先前基于快照的约定。 `CurrentTimeline` 返回 `TranscriptTimeline` 不再使用时间线快照， `Changed` 提供 `TranscriptChangeBatch`，以及 `Subscribe`/`SubscribeCommitted` 回调接收 `TranscriptChange` 值。对于任何使用旧快照类型的代码，这都是一项破坏性更改——请参见 [转录 API](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference/transcript-api.md) 参考文档了解完整迁移路径。

**角色动作**

* `ConvaiActionConfigPatch` 在活动会话期间更新角色的动作、角色目标、对象目标和当前关注对象，并采用“省略与空列表”的语义以及生成的更新 ID
* `ConvaiActionDefinition.WaitForBotSpeech` （在……上镜像 `ConvaiActionCommand`）使新批次中的第一个动作在执行前等待角色语音，并可选地 `DelayAfterBotSpeechSeconds` 暂停以及调度器级别的语音门控超时，从而使沉默回合不会阻塞批次

**AI 编码助手集成**

**Convai > AI 编码设置** 会打开一个新的编辑器部分，用于配置基于 Unity MCP 的 AI 编码辅助，支持 Codex、Claude Code、Cursor、Gemini 和 VS Code Copilot。专门的文档部分对该集成进行了完整说明。

**动态视觉上下文**

房间可以通过一个新的 Dynamic Vision Context 部分选择启用后端帧采样，该部分位于 `ConvaiRoomManager` 和 `ConvaiRoomManagerProfile`.

**Convai SDK 设置**

该 **Convai SDK** 项目设置页面（**编辑 > 项目设置 > Convai SDK**）以及编辑器窗口的新 **Convai > 设置** 部分共享同一实现，涵盖设置健康状态、凭证、运行时默认值、诊断、高级和关于。凭证部分新增了 API 密钥混淆，并可从明文自动迁移；还新增了环境预设（Production、Beta 或 Custom），以及带缓存验证徽标的“验证并保存”操作。

**LipSync**

播放对齐加固将 NeuroSync 口型同步锚定到语音开始的精确音频帧，从而减少长响应或中断响应中的漂移。

**破坏性更改**

* `ConvaiSettings.DefaultMicrophoneIndex` 已被替换为 `DefaultMicrophoneDeviceId` （字符串）——整数索引不会迁移；请在 设置 > 运行时默认值 中重新选择麦克风
* `ConvaiSettings.ServerUrl` 现在由环境预设派生——序列化的 URL 仅在环境为 `Custom`
* 该 **Convai > 日志设置** 菜单已移除——日志配置位于 **Convai > 设置** （诊断）
* `ConvaiRespondMode` 统一了响应模式的术语（`ConvaiContextReactionMode` 已移除）——仅与针对未发布测试版构建保存的场景相关
  {% endupdate %}

{% update date="2026-06-23" tags="v4.3.0" %}

## v4.3.0

* **VAD 设置：** 可配置的连接时用户语音活动检测（VAD）设置，用于房间连接，包含房间和配置文件 Inspector 控件以及服务器默认值处理
* **动态上下文 v2：** 带有跟踪状态和事件、批处理、确认/结果事件以及 `ConvaiDynamicContextRelay` 创作界面
* **世界对象上下文：** 同步的世界对象上下文通过动态上下文发送跟踪到的场景元数据和当前焦点对象
* **叙事触发器：** 用于已保存触发器、内联事件和脚本化语音的独立触发模式
* **转写 UI：** 用于空间 UI 设置的世界空间聊天转写预制体
* **动作：** 动作配置验证和重复绑定保留，包含步骤诊断和动作调试探测
* **聊天输入：** 聊天输入的回车聚焦行为

**迁移说明**

* 动态上下文现在使用 v2 跟踪更新流程——请优先使用 `ConvaiCharacter.DynamicContext` 或 `ConvaiDynamicContextRelay` 而不是已移除的命令式动态上下文 UI
* 叙事触发请求现在会携带显式模式——请根据所需的后端行为使用已保存触发器、内联事件或脚本化语音
* 自定义 VAD 值仅在房间连接期间发送——当后端应负责 VAD 默认值时，请使用服务器默认选项
  {% endupdate %}

{% update date="2026-05-08" tags="v4.2.0" %}

## v4.2.0

**动作系统**

角色可以通过结构化运行时执行场景内命令。本版本新增：

* `ConvaiActionDispatcher` 采用队列式分发——动作按顺序执行，不会出现竞态条件
* `IConvaiActionExecutor` 用于自定义执行器的接口
* 六个内置执行器：移动到（Transform 和 NavMesh）、拾取、注视、Animator 触发器以及 UnityEvent
* 由 Inspector 驱动的配置——标准动作设置无需编写脚本
* 用于监控动作队列状态的运行时诊断

**Meta Quest 透视穿透视觉**

`QuestVisionFrameSource` 可在 Quest 3 和 Quest 3S 设备上启用 Vision 模块，无需外接相机。角色在混合现实会话期间通过设备的透视相机看见外界。

**运行时轮流发言模式切换**

在实时会话中使用 `ConvaiManager.SetConversationInputModeAsync()` 或者运行时设置面板——无需重新加载场景。

**动态上下文扩展**

* Tracker API 让你可从脚本中监控当前上下文状态
* 用于无需代码编写上下文命令的 Inspector 工具
* `SampleDynamicContextUI` 预制体演示运行时注入模式

**场景设置工具与验证**

通过菜单创建组件（**GameObject > Convai > Setup Required Components**）和场景验证（**GameObject > Convai > 验证场景设置**）可在进入 Play 模式前防止配置错误。

**设置面板输入模式控制**

运行时设置面板现在支持输入模式切换——玩家或开发者无需编写脚本即可在会话期间更改轮流发言模式。
{% endupdate %}

{% update date="2026-04-09" tags="v4.1.0" %}

## v4.1.0

* **动态上下文：** `ConvaiDynamicContextCommand` 组件可在运行时将状态和事件注入角色知识中
* **LipSync 示例：** 已从 LipSync 示例场景中移除相机依赖——可适用于任何相机配置
* **Vision 模块：** 提升了帧源生命周期和重连处理的可靠性
* **iOS：** 修复了首次访问麦克风时的崩溃问题，当 `NSMicrophoneUsageDescription` 未出现在构建设置中
* **示例场景：** 优化了 Basic 和 LipSync 示例中的设置与场景结构
* **编辑器：** 提高了包含大量场景的项目的启动时间表现
  {% endupdate %}

{% update date="2026-03-12" tags="v4.0.0,Initial Release" %}

## v4.0.0

Convai Unity SDK 的首次公开发布。

**核心组件：** `ConvaiManager`, `ConvaiRoomManager`, `ConvaiCharacter`, `ConvaiPlayer`

**对话管线：** 语音转文本、语言理解与生成、文本转语音——完全实时流式传输

**模块：** LipSync、情绪、视觉、叙事设计、动态上下文、长期记忆、场景元数据、对话动画、凝视与注意力

**平台支持：** Windows、macOS、Linux、Android、iOS、WebGL

**编辑器工具：** 场景设置、验证、Project Settings 集成，以及 Convai 欢迎窗口
{% endupdate %}
{% endupdates %}

### 下一步

要开始使用该 SDK，请参阅 Getting Started。

{% content-ref url="/pages/5ea68df21c8a54f95779af92056a9ab831531be5" %}
[快速入门](/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/overview/release-notes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.