OpenAIKit

Swift

OpenAIKit 是一个 Swift 包，用于与 OpenAI API 进行通信。

设置

将依赖项添加到 Package.swift

dependencies: [
    ...
    .package(url: "https://github.com/dylanshine/openai-kit.git", from: "1.0.0")
],
targets: [
    .target(name: "App", dependencies: [
        .product(name: "OpenAIKit", package: "openai-kit"),
    ]),

建议使用环境变量来注入 OpenAI API 密钥，而不是将其硬编码在源代码中。

# .env

OPENAI_API_KEY="YOUR-API-KEY"
OPENAI_ORGANIZATION="YOUR-ORGANIZATION"

⚠️OpenAI 强烈建议客户端应用程序的开发者通过单独的后端服务代理请求，以确保其 API 密钥的安全。API 密钥可以访问和操作客户的账单、使用情况和组织数据，因此 暴露 它们会带来重大风险。

通过传递配置来创建一个 OpenAIKit.Client。

var apiKey: String {
    ProcessInfo.processInfo.environment["OPENAI_API_KEY"]!
}

var organization: String {
    ProcessInfo.processInfo.environment["OPENAI_ORGANIZATION"]!
}

...

// Generally we would advise on creating a single HTTPClient for the lifecycle of your application and recommend shutting it down on application close.

let eventLoopGroup = MultiThreadedEventLoopGroup(numberOfThreads: 1)

let httpClient = HTTPClient(eventLoopGroupProvider: .shared(eventLoopGroup))

defer {
    // it's important to shutdown the httpClient after all requests are done, even if one failed. See: https://github.com/swift-server/async-http-client
    try? httpClient.syncShutdown()
}

let configuration = Configuration(apiKey: apiKey, organization: organization)

let openAIClient = OpenAIKit.Client(httpClient: httpClient, configuration: configuration)

如果您不想使用 SwiftNIO，可以使用 URLSession。

let urlSession = URLSession(configuration: .default)
let configuration = Configuration(apiKey: apiKey, organization: organization)
let openAIClient = OpenAIKit.Client(session: urlSession, configuration: configuration)

使用 API

OpenAIKit.Client 实现了一些与 OpenAI API 交互的方法

import OpenAIKit

let completion = try await openAIClient.completions.create(
    model: Model.GPT3.davinci,
    prompts: ["Write a haiku"]
)

已实现的功能

错误处理

如果由于任何原因导致对 API 的请求失败，则会 抛出 一个 OpenAIKit.APIErrorResponse。只需确保像捕获任何其他抛出函数一样捕获抛出的错误

do {
   ...
} catch let error as APIErrorResponse {
    print(error)
}