OpenAIKit

OpenAIKit 项目介绍

关于项目

OpenAIKit 是一个由社区维护的 Swift 软件开发工具包 (SDK)，专为帮助 Swift 开发者便捷、有效地与 OpenAI 的 REST 接口交互而设计。其目标是降低 Swift 开发者的使用门槛，使他们能够轻松将 OpenAI 的强大功能整合到他们的应用中，而无需深入了解 RESTful 服务的复杂性。

动机

随着现代应用对人工智能功能需求的增加，开发者亟需能简化整合过程的工具。虽然 OpenAI 提供了出色的功能套件，但显然需要一个符合 Swift 语言惯用做法，并迎合 Swift 开发者社区期望的专用 Swift SDK。

我们的愿景

我们希望提供的不仅仅是对 OpenAI 功能的简单访问工具，而是一个能通过清晰直观的接口增强开发者体验的工具。我们的终极目标是通过提供合适的工具促进 Swift 社区创新，使开发者轻松将 AI 功能整合到他们的应用中。

特性

• 使用 DALL-E 2 生成新图像、编辑和变体（DALL-E 3 即将推出）。
• 使用 GPT-3 和 GPT-4 生成编辑和完成。
• 提供 GPT-3 和 GPT-4 可用模型列表。
• 提供 GPT-3 和 GPT-4 提示的嵌入。
• 为 GPT-3 和 GPT-4 的完成过程流式传输数据。
• 使用 ChatGPT 生成聊天响应。
• 查看和上传训练文件。
• 查看提示是否被 Moderations 端点标记。
• 提供全面的单元和集成测试覆盖。
• 支持 Swift 并发，适用于 iOS 13、macOS 10.15、tvOS 13、watchOS 6 和 visionOS 1.0。
• 完整的 OpenAIKit 文档。

要求

平台	最低 Swift 版本	安装	状态
iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+ / visionOS 1.0+	5.7	使用 Swift 包管理器	完全测试

安装

使用 Swift 包管理器

Swift 包管理器允许开发者轻松将包整合到他们的 Xcode 项目和包中，并且完全融入 Swift 编译器。

通过 Xcode 项目使用 SPM

1. File > Swift Packages > Add Package Dependency
2. 添加 https://github.com/OpenDive/OpenAIKit.git
3. 选择“Up to next Major”并设定为“2.0.1”

通过 Xcode 包使用 SPM

在设定好的 Swift 包中，将上述 Git 链接添加到 Package.swift 文件的 dependencies 属性中。

dependencies: [
    .package(url: "https://github.com/OpenDive/OpenAIKit.git", .upToNextMajor(from: "2.0.1"))
]

使用 OpenAIKit

获取 API 密钥

要获取 API 密钥，前往您的账户页面并点击“API 密钥”页面。注意不要在代码中直接存储 OpenAI API 密钥。

图片

利用 DALL-E 2（即将推出 DALL-E 3）实现 AI 驱动的图像生成。DALL-E 2 能够通过文本提示，生成复杂的视觉效果，为开发者提供丰富的用户体验，创造动态内容和引发新的创意灵感。使用该技术可以为您的应用和项目带来革命性提升。

有三个主要接口与 DALL-E 2 进行交互：创建图像、创建图像编辑和创建图像变体。

聊天

ChatGPT 基于 OpenAI 的 GPT-4 架构，是一个尖端的会话 AI 模型。它为开发者提供了将高级自然语言处理能力整合到应用中的强大工具，能够增强用户互动、提高效率并在各种应用场景中提供基于 AI 的解决方案。

音频

Whisper 是 OpenAI 的语音转文本 AI 模型，用于准确转录口述内容。通过将音频转换为文本，它为开发者提供了一种直接处理转录服务、语音命令、语音翻译或音频索引等任务的工具。

实用工具

嵌入

嵌入功能利用 OpenAI 的 GPT 模型来生成文本的密集向量表示。这些嵌入捕捉语义信息，使开发者能够执行相似性搜索、聚类或针对特定任务进行微调。

模型

模型功能使开发者能够从 OpenAI 获取当前可用的模型以及他们自己微调的模型。

完成

迁移指南

从 1.x 版本到 2.x 版本的迁移可以更好地利用 Chat Completion Models 的枚举标签，使默认模型的使用更加简单。

示例项目

（正在开发中）

开发和测试

欢迎任何人通过提交问题来为该项目做出贡献，如果他们在使用 OpenAIKit 时遇到任何问题/故障。我们也欢迎通过创建拉取请求来添加任何额外功能。

许可证

OpenAIKit 以 MIT 许可证发布，任何对 OpenAI REST 接口的使用都将遵循其制定的使用政策。