OpenAI

OpenAI 项目介绍

项目概述

OpenAI 是一个由社区维护的仓库，提供了基于 OpenAI 公共 API 的 Swift 实现。这个 API 可以应用于几乎任何涉及理解或生成自然语言或代码的任务。它提供了一系列不同能力的模型以适应不同的任务，同时也允许用户微调定制自己的模型。这些模型可以用于从内容生成到语义搜索和分类的各种用途。

安装说明

OpenAI 可以通过 CocoaPods 和 Swift Package Manager（Swift 包管理工具）进行安装。

使用 CocoaPods

CocoaPods 是一个 Cocoa 项目的依赖管理工具。要在 Xcode 项目中集成 OpenAI，可以在 Podfile 中添加如下代码：

pod 'OpenAIKit'

使用 Swift Package Manager

Swift Package Manager 是一个用于自动分发 Swift 代码的工具，并集成在 swift 编译器中。在设置 Swift 包后，只需将 OpenAI 添加到 Package.swift 的 dependencies 中即可：

dependencies: [
    .package(url: "https://github.com/FuturraGroup/OpenAI.git", .branch("main"))
]

使用方法

初始化

建议使用环境变量来传递 OpenAI API 密钥，而不是在源代码中硬编码。可以在项目中方便的地方初始化 OpenAIKit。API 密钥和组织名称可以作为初始化参数，其中组织名称是可选的。

import OpenAIKit

public let openAI = OpenAIKit(apiToken: apiToken, organization: organizationName)

SSL 握手

为了保护数据免受中间人攻击，可以使用 SSL 握手功能。此功能通过验证提供的证书路径与 OpenAI 或用户服务器的证书来保护 API 密钥和请求数据。

功能介绍

文本完成

可以向 OpenAI API 发送一个文本提示，获取模型生成的结果。支持异步调用和同步调用，处理结果的方式也十分灵活。

openAI.sendCompletion(prompt: "Hello!", model: .gptV3_5(.davinciText003), maxTokens: 2048) { result in
    ... // 处理结果
}

聊天完成

聊天完成与文本完成类似，但支持理解上下文，并仅支持特定的模型，比如 gpt-3.5-turbo。通过传递之前的聊天记录，模型可以生成更连贯的对话。

流模式

在请求文本完成和聊天完成时，可以使用流模式来获取实时的部分响应，而不必等待完整响应完成。

JSON模式

可以选择让模型返回 JSON 格式的响应，以便更好地处理返回数据。

openAI.sendChatCompletion(newMessage: AIMessage(role: .user, content: prompt), ... , responseFormat: .json, completion: { result in
    ... // 处理结果
})

图像生成

DALL·E 是一个可以从自然语言描述创建逼真图像和艺术作品的 AI 系统。可以通过输入提示创建新图像、编辑现有图像或对用户提供的图像创建变体。

openAI.sendImagesRequest(prompt: "bird", size: .size512, n: 1) { result in
    ... // 处理结果
}

贡献和许可证

欢迎贡献提升功能的点子，例如提交拉取请求改善库。该项目采取 MIT 许可证，意味着使用者可以自由复制、修改和分发软件。

如有任何与功能建议或错误报告相关的问题，可以提交至项目的 Issues 页面。