ChatGPTSwift API

使用 Swift 访问 OpenAI ChatGPT 官方 API。适用于所有 Apple 平台。

支持的平台

• iOS/tvOS 15 及以上
• macOS 12 及以上
• watchOS 8 及以上
• Linux

安装

Swift Package Manager（Swift 包管理器）

• 文件 (File) > Swift Packages > 添加包依赖 (Add Package Dependency)
• 添加 https://github.com/alfianlosari/ChatGPTSwift.git

Cocoapods

platform :ios, '15.0'
use_frameworks!

target 'MyApp' do
  pod 'ChatGPTSwift', '~> 2.5.0'
end

要求

从 OpenAI 注册 API 密钥（API Key）。使用 API 密钥进行初始化

let api = ChatGPTAPI(apiKey: "API_KEY")

用法

有两种 API：流式（stream）和普通（normal）

流式传输 (Stream)

服务器将流式传输数据块直到完成，方法 AsyncThrowingStream（异步抛出流）允许你像这样使用 For 循环（For-Loop）进行遍历：

Task {
    do {
        let stream = try await api.sendMessageStream(text: "What is ChatGPT?")
        for try await line in stream {
            print(line)
        }
    } catch {
        print(error.localizedDescription)
    }
}

普通模式 (Normal)

标准的 HTTP 请求和响应生命周期。服务器将发送完整的文本（响应时间会更长）

Task {
    do {
        let response = try await api.sendMessage(text: "What is ChatGPT?")
        print(response)
    } catch {
        print(error.localizedDescription)
    }
}
        

提供额外参数

可选地，你可以提供模型（model）、系统提示词（system prompt）、温度（temperature）等参数，如下所示。

let response = try await api.sendMessage(text: "What is ChatGPT?",
                                         model: "gpt-4",
                                         systemText: "You are a CS Professor",
                                         temperature: 0.5)

这些参数的默认值为：

• model: gpt-3.5-turbo
• systemText: You're a helpful assistant
• temperature: 0.5

要了解更多关于这些参数的信息，你可以访问官方 ChatGPT API 文档 和 ChatGPT API 介绍页面

历史记录列表

客户端会存储对话的历史记录列表，该列表将被包含在新的提示词中，以便 ChatGPT 了解之前的对话上下文。当发送新提示词时，客户端会使用 GPTEncoder 库 计算字符串中的令牌（Token）数量，确保令牌计数不超过 4096。如果超过令牌限制，部分之前的对话将被截断。未来我将提供一个 API 来指定令牌阈值，因为新的 gpt-4 模型在单个提示词中接受更大的 8k 令牌。

查看当前历史记录列表

你可以从 historyList 属性查看当前的历史记录列表。

print(api.historyList)

删除历史记录列表

你也可以通过调用以下方法来删除历史记录列表

api.deleteHistoryList()

替换历史记录列表

你可以提供自己的历史记录列表，这将替换存储的历史记录列表。请记住不要超过 4096 个令牌的阈值。

let myHistoryList = [
    Message(role: "user", content: "who is james bond?")
    Message(role: "assistant", content: "secret british agent with codename 007"),
    Message(role: "user", content: "which one is the latest movie?"),
    Message(role: "assistant", content: "It's No Time to Die played by Daniel Craig")
]

api.replaceHistoryList(with: myHistoryList)

GPT Encoder 库

我还创建了 GPTEncoder Swift BPE 编码器/解码器，用于 OpenAI GPT 模型。这是一个用于为 OpenAI GPT API 对文本进行标记化（Tokenizing）的编程接口。

GPT Tokenizer UI 库

我还创建了 GPTTokenizerUI，这是一个 SPM 库（Swift Package Manager 库），你可以将其集成到你的应用中，以提供图形用户界面（GUI）输入文本并显示 GPT API 使用的标记化结果。

演示应用

你可以从 SwiftUIChatGPT 仓库 查看 iOS 和 macOS 的演示应用

ChatGPTSwift 快速上手指南

ChatGPTSwift 是一个专为 Swift 开发者设计的开源库，用于在 Apple 平台及 Linux 上便捷地调用 OpenAI ChatGPT 官方 API。

环境准备

系统要求

• iOS / tvOS: 15.0 及以上
• macOS: 12.0 及以上
• watchOS: 8.0 及以上
• Linux: 支持

前置依赖

• 已安装 Xcode（适用于 Apple 平台开发）
• 拥有有效的 OpenAI API Key

安装步骤

你可以根据项目需求选择 Swift Package Manager 或 CocoaPods 进行集成。

方式一：Swift Package Manager (推荐)

1. 在 Xcode 中打开项目。
2. 点击菜单栏 File > Swift Packages > Add Package Dependency。
3. 输入以下仓库地址并确认：

https://github.com/alfianlosari/ChatGPTSwift.git

方式二：CocoaPods

在项目根目录的 Podfile 中添加以下内容：

platform :ios, '15.0'
use_frameworks!

target 'MyApp' do
  pod 'ChatGPTSwift', '~> 2.5.0'
end

执行 pod install 完成安装。

基本使用

1. 初始化 API

引入库后，首先需要使用你的 API Key 初始化客户端：

let api = ChatGPTAPI(apiKey: "API_KEY")

2. 发送消息（普通模式）

最基础的用法是发送文本请求并获取完整回复：

Task {
    do {
        let response = try await api.sendMessage(text: "What is ChatGPT?")
        print(response)
    } catch {
        print(error.localizedDescription)
    }
}

3. 发送消息（流式模式）

如果你需要实时接收数据流，可以使用流式接口：

Task {
    do {
        let stream = try await api.sendMessageStream(text: "What is ChatGPT?")
        for try await line in stream {
            print(line)
        }
    } catch {
        print(error.localizedDescription)
    }
}

4. 自定义参数（可选）

你可以指定模型、系统提示词和温度等参数：

let response = try await api.sendMessage(text: "What is ChatGPT?",
                                         model: "gpt-4",
                                         systemText: "You are a CS Professor",
                                         temperature: 0.5)

默认参数说明：

• model: gpt-3.5-turbo
• systemText: You're a helpful assistant
• temperature: 0.5