Swift 中的 OpenAI API 客户端库

这是一个由社区维护的库，用于访问 OpenAI 的 HTTP API。完整的 API 文档可以在这里找到： https://beta.openai.com/docs

安装 💻

Swift 包管理器（推荐）

你可以使用 Swift 包管理器来集成该库，在 Package.swift 文件中添加以下依赖项，或者直接在 Xcode 中添加。

.package(url: "https://github.com/adamrushy/OpenAISwift.git", from: "1.2.0")

CocoaPods

CocoaPods 是一个适用于 Cocoa 项目的依赖管理工具。有关使用和安装说明，请访问其官网。要通过 CocoaPods 将 OpenAISwift 集成到你的 Xcode 项目中，请在你的 Podfile 中指定：

pod 'OpenAISwift'

手动方式

将源文件复制到你自己的项目中。

使用 🤩

在你的项目中导入框架：

import OpenAISwift

创建一个 OpenAI API 密钥，并将其添加到你的配置中：

let openAI = OpenAISwift(config: OpenAISwift.Config.makeDefaultOpenAI(apiKey: MY SECRET KEY))

该框架支持 Swift 并发；下面的每个示例都同时提供了 async/await 和完成处理程序两种版本。

补全

预测输入文本的补全内容。

openAI.sendCompletion(with: "Hello how are you") { result in // Result<OpenAI, OpenAIError>
    switch result {
    case .success(let success):
        print(success.choices.first?.text ?? "")
    case .failure(let failure):
        print(failure.localizedDescription)
    }
}

这将返回一个包含补全结果的 OpenAI 对象。

还支持其他 API 参数：

do {
    let result = try await openAI.sendCompletion(
        with: "What's your favorite color?",
        model: .gpt3(.davinci), // 可选的 `OpenAIModelType`
        maxTokens: 16,          // 可选的 `Int?`
        temperature: 1          // 可选的 `Double?`
    )
    // 使用结果
} catch {
    // ...
}

有关支持的完整模型列表，请参阅 OpenAIModelType.swift。更多关于模型的信息，请参阅 OpenAI API 文档。

聊天

通过 ChatGPT（即 GPT-3.5）和 GPT-4（处于测试阶段）获取聊天对话的响应。

do {
    let chat: [ChatMessage] = [
        ChatMessage(role: .system, content: "You are a helpful assistant."),
        ChatMessage(role: .user, content: "Who won the world series in 2020?"),
        ChatMessage(role: .assistant, content: "The Los Angeles Dodgers won the World Series in 2020."),
        ChatMessage(role: .user, content: "Where was it played?")
    ]

    let result = try await openAI.sendChat(with: chat)
    // 使用结果
} catch {
    // ...
}

所有 API 参数均受支持，除了在消息完成之前进行流式传输之外：

do {
    let chat: [ChatMessage] = [...]

    let result = try await openAI.sendChat(
        with: chat,
        model: .chat(.chatgpt),         // 可选的 `OpenAIModelType`
        user: nil,                      // 可选的 `String?`
        temperature: 1,                 // 可选的 `Double?`
        topProbabilityMass: 1,          // 可选的 `Double?`
        choices: 1,                     // 可选的 `Int?`
        stop: nil,                      // 可选的 `[String]?`
        maxTokens: nil,                 // 可选的 `Int?`
        presencePenalty: nil,           // 可选的 `Double?`
        frequencyPenalty: nil,          // 可选的 `Double?`
        logitBias: nil                 // 可选的 `[Int: Double]?`（请参阅内联文档）
    )
    // 使用结果
} catch {
    // ...
}

图像（DALL·E）

根据提示生成一张图片。

openAI.sendImages(with: "A 3d render of a rocket ship", numImages: 1, size: .size1024) { result in // Result<OpenAI, OpenAIError>
    switch result {
    case .success(let success):
        print(success.data.first?.url ?? "")
    case .failure(let failure):
        print(failure.localizedDescription)
    }
}

编辑

根据提示和指令对文本进行编辑。

do {
    let result = try await openAI.sendEdits(
        with: "Improve the tone of this text.",
        model: .feature(.davinci),               // 可选的 `OpenAIModelType`
        input: "I am resigning!"
    )
    // 使用结果
} catch {
    // ...
}

内容审核

对文本进行分类以用于内容审核目的（更多信息请参阅 OpenAI 参考资料）。

do {
    let result = try await openAI.sendModeration(
        with: "Some harmful text...",
        model: .moderation(.latest)     // 可选的 `OpenAIModelType`
    )
    // 使用结果
} catch {
    // ...
}

嵌入

获取给定输入的向量表示，该表示可以被机器学习模型和算法轻松消费。（更多信息请参阅 OpenAI 参考资料）。

do {
    let result = try await openAI.sendEmbeddings(
        with: "The food was delicious and the waiter..."
    )
    // 使用结果
} catch {
    // ...
}

贡献 ❤️

我主要是出于兴趣而创建了这个库，我们可以添加更多的端点，并进一步探索这个库。欢迎提交 PR 来帮助扩展这个库。

许可证 📥

MIT 许可证（MIT）

版权所有 © 2022 Adam Rush

特此授予任何人免费获取本软件及与其相关的文档文件（“软件”）副本的权利，允许以任何方式处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售该软件的副本，并允许向其提供本软件的人进行上述操作，但须遵守以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或重要部分中。

“软件”按“原样”提供，不提供任何形式的明示或暗示担保，包括但不限于适销性、特定用途适用性和非侵权性担保。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论该等责任是基于合同、侵权或其他原因，亦无论该等责任是否源于、与本软件有关或因使用本软件而产生。

OpenAISwift 快速上手指南

OpenAISwift 是一个由社区维护的 Swift 库，用于轻松访问 OpenAI HTTP API。它支持 Swift 原生并发（async/await）和传统的回调模式。

环境准备

• 操作系统：macOS, iOS, watchOS, tvOS, Linux
• 开发工具：Xcode 14.0+ 或 Swift 5.7+
• 前置依赖：
  • 有效的 OpenAI API Key（需在 OpenAI 平台 获取）
  • 网络连接（需能访问 api.openai.com）

安装步骤

推荐使用 Swift Package Manager (SPM) 进行安装。

方式一：在 Xcode 中直接添加

1. 打开你的 Xcode 项目。
2. 点击菜单栏 File > Add Packages...。
3. 在搜索框输入以下仓库地址：

   https://github.com/adamrushy/OpenAISwift.git
   

4. 选择版本规则为 Up to Next Major Version，起始版本设为 1.2.0，点击 Add Package。

方式二：手动编辑 Package.swift

如果你在使用纯 Swift 包管理，请在 Package.swift 的 dependencies 数组中添加：

.package(url: "https://github.com/adamrushy/OpenAISwift.git", from: "1.2.0")

并在你的 target 依赖中添加 "OpenAISwift"。

方式三：CocoaPods (可选)

在 Podfile 中添加：

pod 'OpenAISwift'

然后运行 pod install。

基本使用

1. 导入与初始化

在你的 Swift 文件中导入框架并配置 API Key：

import OpenAISwift

// 替换为你的真实 API Key
let openAI = OpenAISwift(config: OpenAISwift.Config.makeDefaultOpenAI(apiKey: "YOUR_SECRET_KEY"))

2. 发送文本补全请求 (Completions)

以下示例展示了如何使用 async/await 语法调用 GPT-3 模型：

do {
    let result = try await openAI.sendCompletion(
        with: "Hello, how are you?",
        model: .gpt3(.davinci), // 指定模型
        maxTokens: 16,          // 最大生成 token 数
        temperature: 1          // 创造性参数
    )
    
    // 打印返回的第一个选项
    print(result.choices.first?.text ?? "")
} catch {
    print("Error: \(error.localizedDescription)")
}

3. 发送聊天请求 (Chat / ChatGPT)

调用 ChatGPT (GPT-3.5) 或 GPT-4 进行对话：

do {
    let chat: [ChatMessage] = [
        ChatMessage(role: .system, content: "You are a helpful assistant."),
        ChatMessage(role: .user, content: "Who won the world series in 2020?")
    ]

    let result = try await openAI.sendChat(with: chat, model: .chat(.chatgpt))
    
    // 打印助手回复
    print(result.choices.first?.message.content ?? "")
} catch {
    print("Error: \(error.localizedDescription)")
}

提示：该库也支持传统的闭包回调方式（Completion Handler），具体用法可参考上述代码将 try await 替换为闭包结构。