跳到主要内容

如何使用插件

Runtime AI Chatbot Integrator 提供两大主要功能:文本到文本聊天(Text-to-Text chat)和文本到语音转换(Text-to-Speech,TTS)。两项功能遵循相似的工作流程:

  1. 注册您的API提供商令牌
  2. 配置功能特定设置
  3. 发送请求并处理响应

注册提供商令牌

在发送任何请求之前,请使用 RegisterProviderToken 函数注册您的API提供商令牌。

在蓝图中注册提供商令牌

文本转文本聊天功能

该插件为每个服务提供商支持两种聊天请求模式:

非流式聊天请求

通过单次调用获取完整响应。

发送OpenAI聊天请求

流式聊天请求

实时接收响应数据块,实现更具动态性的交互体验。

发送OpenAI流式聊天请求

文本转语音 (TTS) 功能

使用领先的 TTS 提供商将文本转换为高质量的语音音频。该插件返回原始音频数据 (TArray<uint8>),您可以根据项目需求进行处理。

以下示例演示了如何使用 Runtime Audio Importer 插件(参见 音频导入文档)进行音频播放处理,但 Runtime AI Chatbot Integrator 设计灵活。插件仅返回原始音频数据,您可以完全自由地根据具体用例进行处理,包括音频播放、保存到文件、进一步音频处理、传输到其他系统、自定义可视化等。

非流式 TTS 请求

非流式 TTS 请求会在整个文本处理完成后一次性返回完整的音频数据。这种方法适用于较短的文本,等待完整音频不会造成问题。

发送 OpenAI TTS 请求

流式 TTS 请求

流式 TTS 会在音频块生成时立即传输,允许您逐步处理数据,而无需等待整个音频合成完成。这能显著降低长文本的感知延迟,并支持实时应用。

发送 OpenAI 流式 TTS 请求

错误处理

发送任何请求时,必须通过回调函数中的 ErrorStatus 检查来处理潜在错误。ErrorStatus 会提供请求过程中可能出现的任何问题信息。

错误处理

取消请求

该插件允许您在文本转文本和TTS请求进行中时取消它们。当您需要中断长时间运行的请求或动态改变对话流程时,这个功能会非常有用。

取消请求

最佳实践

  1. 始终通过检查回调中的 ErrorStatus 来处理潜在错误
  2. 注意API速率限制和成本控制
  3. 对于长文本或交互式对话使用流式传输模式
  4. 考虑取消不再需要的请求以高效管理资源
  5. 对较长文本使用流式TTS以降低感知延迟
  6. 音频处理方面,Runtime Audio Importer插件提供了便捷解决方案,但您也可以根据项目需求实现自定义处理

故障排除

  • 确认API凭证是否正确
  • 检查网络连接
  • 确保使用TTS功能时,所有音频处理库(如Runtime Audio Importer)已正确安装
  • 处理TTS响应数据时验证是否使用了正确的音频格式
  • 对于流式TTS,确保正确处理音频数据块