Skip to content

Latest commit

 

History

History
113 lines (82 loc) · 3.14 KB

File metadata and controls

113 lines (82 loc) · 3.14 KB

Magic Button功能文档

功能概述

Magic Button是Tuna应用中的一项新功能,旨在通过人工智能优化语音转写文本。当用户完成语音转写后,可以通过点击Magic按钮将转写结果发送到OpenAI API进行处理,使文本表达更加清晰、连贯和专业。

主要功能包括:

  • 一键优化语音转写文本
  • 实时显示处理状态和错误信息
  • 自动将处理后的文本复制到剪贴板
  • 完整的错误处理和用户反馈

技术实现

核心组件

  1. MagicTransformManager

    • 作为状态管理器,负责控制转换流程
    • 管理处理状态、错误信息和结果
    • 与剪贴板功能集成,实现结果自动复制
    • 实现了完整的错误处理流程
  2. MagicTransformService

    • 负责与OpenAI API的通信
    • 构建API请求并处理响应
    • 实现错误处理和超时管理
    • 确保API密钥的安全管理
  3. UI集成

    • 在TunaDictationView中添加Magic按钮
    • 根据处理状态动态更新按钮图标和状态
    • 显示处理进度和错误信息
    • 优化用户体验和交互流程

数据流程

  1. 用户点击Magic按钮
  2. MagicTransformManager将文本发送给MagicTransformService
  3. MagicTransformService向OpenAI API发送请求
  4. API返回处理后的文本
  5. MagicTransformManager更新状态并保存结果
  6. 处理结果显示在编辑框中并复制到剪贴板
  7. 用户收到成功或错误的反馈信息

使用指南

如何使用Magic功能

  1. 启用Magic功能

    • 在设置中确保Magic功能已启用
    • 确保API密钥已正确配置
  2. 录制和转写文本

    • 使用录音功能录制语音
    • 等待转写完成
  3. 优化文本

    • 点击工具栏中的Magic按钮(魔杖图标)
    • 等待处理完成,查看状态指示
    • 优化后的文本会自动替换原文本并复制到剪贴板
  4. 处理错误

    • 如果遇到错误,会显示相应的错误信息
    • 可以尝试再次点击Magic按钮
    • 如果持续出错,请检查网络连接和API密钥设置

设置选项

  • 启用/禁用Magic功能:在设置界面中可以开启或关闭此功能
  • API密钥配置:在设置中可以配置OpenAI API密钥

测试与验证

为确保功能的稳定性和可靠性,我们实现了多种测试:

  1. 单元测试

    • 测试MagicTransformManager的状态管理
    • 验证错误处理流程
  2. 模拟测试

    • 使用MockURLProtocol模拟API响应
    • 测试各种响应场景和错误情况
  3. 手动验证

    • 验证UI交互和状态反馈
    • 确认处理流程和结果显示

后续计划

待实现功能

  1. 多种转换模式

    • 添加不同风格的转换选项(正式、简洁、创意等)
    • 允许用户自定义转换提示词
  2. 优化性能

    • 改进API调用效率
    • 减少响应时间和资源消耗
  3. 高级功能

    • 转换历史记录
    • 批量处理功能
    • 定制化转换选项
  4. 离线模式

    • 提供基础的离线优化功能
    • 减少对网络连接的依赖

贡献者

  • 开发团队:Tuna项目组
  • 完成日期:2025-04-18
  • 版本:集成于v1.2