SwiftyGPT 是一个非官方的、轻量级的且用户友好的 Swift 封装器，用于访问 OpenAI API。

• 简单：SwiftyGPT 的设计理念是简单易用，无需进行大量的配置，开箱即用，您只需要您的 API 密钥！ 告别繁琐的编码，迎接与 OpenAI 功能轻松交互的时代！
• 可定制：无论您是想微调模型选择等参数，调整温度，还是依赖默认值，SwiftyGPT 都能提供灵活性以满足您的需求。
• 模块化：SwiftyGPT 被划分为多个模块，每个模块针对 API 公开的不同功能。 只导入您真正需要的代码，保持项目的轻量和高效。
• 可模拟：SwiftyGPT 采用面向协议的编程，以保证可测试性和可维护性。 它已经公开了一些模拟对象，可以无缝地在测试或 SwiftUI 预览中使用，无需实际的 API 调用。

将 SwiftyGPT 集成到您的 Swift 项目中非常简单。 按照以下步骤开始：

1. 安装 SwiftyGPT:
   • 如果您使用 Swift Package Manager (SPM)
     • 打开您的 Xcode 项目。
     • 导航到“File”（文件） > “Swift Packages”（Swift 包） > “Add Package Dependency...”（添加包依赖项...）。
     • 输入 SwiftyGPT 仓库 URL：https://github.com/antonio-war/SwiftyGPT。
     • 按照提示选择版本并将 SwiftyGPT 添加到您的项目中。
     • SwiftyGPT 公开了多个 target，只导入您项目中真正需要的那些。
   • 如果您使用 CocoaPods 或 Carthage，我们很抱歉，但目前不支持它们。
2. 导入 SwiftyGPT:
   • 在您想要使用 SwiftyGPT 功能的文件中，在文件顶部导入其模块

     import SwiftyGPTChat

3. 开始使用 SwiftyGPT:
   • 导入 SwiftyGPT 后，您可以开始使用其 API 与 GPT 模型进行交互。
   • 请参阅文档，了解如何使用其功能进行文本生成、对话、摘要等等。
4. 运行您的项目:
   • 构建并运行您的项目，以确保 SwiftyGPT 已成功集成。
   • 测试您使用 SwiftyGPT 实现的功能，以确保一切按预期工作。 就是这样！ 您已成功将 SwiftyGPT 集成到您的项目中，现在可以利用其强大的功能了。

下面概述了在您的项目中使用 SwiftyGPTChat 的主要步骤，指导您完成整个过程。

首先，定义一个 SwiftyGPTChatService。 您有三个选项：

• 如果您想对 OpenAI 执行 API 调用（需要 API 密钥），请使用 SwiftyGPTChatNetworkingService。
• 对于模拟响应，请使用 SwiftyGPTChatMockService，非常适合测试或 SwiftUI 预览。
• 创建您的自定义实例以满足您的任何目的。

   import SwiftyGPTChat

   // Using SwiftyGPTChatNetworkingService
   let service = SwiftyGPTChatNetworkingService(apiKey: "YOUR_API_KEY")

   // Using SwiftyGPTChatMockService
   let service = SwiftyGPTChatMockService(responseBody: responseBody, duration: 0.5)

使用定义的服务创建一个 SwiftyGPTChatManager 实例。

   let manager = SwiftyGPTChatManager(service: service)

使用各种可用的消息类型创建您的 prompt。

   let messages: [any SwiftyGPTChatMessage] = [
       SwiftyGPTChatSystemMessage(content: "You are Victor from Fallout New Vegas"),
       SwiftyGPTChatUserMessage(content: "What's your name ?")
   ]

使用定义的消息和对所有可用参数的高度自定义来执行请求。

   let response = try await manager.send(messages: messages, model: .gpt3_5_turbo, frequencyPenalty: 0.5)

如果成功，默认情况下，响应消息会在收到的第一个 choice 中找到。 但这可能会根据您发出的请求类型而有所不同。 但是，如果失败，则响应正文始终包含描述出错原因的错误。

   switch response {
      case .success(let body):
         if let receivedMessage = body.choices.first?.message {
            messages.append(receivedMessage)
         } else {
            print("Oops, there are no available choices!")
         }
       case .failure(let body):
         print(body.error)
    }

通过创新的 Explorer 应用程序，探索 SwiftGPT 的无限可能性。
深入研究自然语言处理领域，并通过这些引人入胜的功能释放 SwiftGPT 的全部潜力：

• 发现全部潜力：当您浏览 Explorer 应用程序的直观界面时，沉浸在 SwiftGPT 的无限功能中。 揭示最先进的 GPT 模型的强大功能，并亲眼目睹它们对文本生成、对话、摘要等方面的变革性影响。
• 探索流行的用例：在 Explorer 应用程序中精心策划的 SwiftGPT 最流行的用例中展开探索。 从制作引人入胜的叙述到参与动态的对话交互，深入研究 SwiftGPT 最闪耀的无数场景。
• 用于无缝集成的实用示例：通过 Explorer 应用程序提供的实用示例和分步指南，将 SwiftGPT 无缝集成到您的项目中。 解锁轻松集成的秘诀，并利用 SwiftGPT 无与伦比的多功能性，将您的应用程序提升到卓越的新高度。

为了确保安全性和灵活性，我们建议使用环境变量加载您的 OpenAI API 密钥，而不是将其直接硬编码到您的源代码中。 这种方法有几个优点：

• 安全性：将 API 密钥等敏感信息存储在环境变量中，有助于防止凭据意外泄露，从而降低未经授权访问您的 API 资源的风险。
• 灵活性：通过使用环境变量，您可以轻松地在不同的 API 密钥之间切换或更新它们，而无需修改您的代码。 这种灵活性在开发、测试和部署场景中尤其有用。
• 最佳实践：将环境变量用于配置被认为是软件开发中的最佳实践，可以促进更简洁、更易于维护的代码库。

这是一个简单的示例，说明如何在 Swift 中从环境变量加载您的 OpenAI API 密钥：

guard let apiKey = ProcessInfo.processInfo.environment["OPEN_AI_API_KEY"] else {
    fatalError("Missing OpenAI API key. Please set the OPEN_AI_API_KEY environment variable.")
}

您的慷慨捐赠有助于维持和改进此项目。 以下是支持我们的重要原因：

1. 支付 API 费用：访问某些功能或服务可能需要付费的 API 密钥。 您的捐款有助于支付维护这些订阅的费用，确保不间断地访问基本功能。
2. 开发和维护：捐款使我们能够投入更多时间和资源来开发新功能、修复错误并维护项目的整体健康状况。 您的支持直接有助于项目的持续改进和可持续性。
3. 社区支持：您的贡献表明您对该项目的支持，并有助于围绕它建立一个蓬勃发展的社区。 您的慷慨激励我们不断推动项目前进，并鼓励其他人加入这一事业。
4. 开源可持续性：通过支持像我们这样的开源项目，您正在为整个开源生态系统的可持续性做出贡献。 您的捐款有助于确保每个人都可以访问有价值的项目。

每一笔捐款，无论多么小，都意义重大。 感谢您考虑支持我们！

此文件的内容已使用 SwiftyGPT 自动生成。

SwiftyGPT 在 MIT 许可证下发布。