https://github.com/dylanshine/openai-kit

A community Swift package used to interact with the OpenAI API
https://github.com/dylanshine/openai-kit

ai chatgpt dall-e gpt-3 openai swift

Last synced: 2 days ago
JSON representation

A community Swift package used to interact with the OpenAI API

• Host: GitHub
• URL: https://github.com/dylanshine/openai-kit
• Owner: dylanshine
• License: mit
• Created: 2023-01-02T18:47:37.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-26T14:15:19.000Z (5 months ago)
• Last Synced: 2025-01-10T09:04:59.192Z (9 days ago)
• Topics: ai, chatgpt, dall-e, gpt-3, openai, swift
• Language: Swift
• Homepage: https://platform.openai.com/docs/api-reference
• Size: 1.2 MB
• Stars: 718
• Watchers: 20
• Forks: 119
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-chatgpt - dylanshine/openai-kit - A community Swift package used to interact with the OpenAI API (SDK, Libraries, Frameworks / Swift)
• awesome-ChatGPT-repositories - openai-kit - A community Swift package used to interact with the OpenAI API (Unity)

README

        
# OpenAIKit

![Swift](http://img.shields.io/badge/swift-5.7-brightgreen.svg)

OpenAIKit is a Swift package used to communicate with the [OpenAI API](https://beta.openai.com/docs/api-reference/introduction).

## Setup

Add the dependency to Package.swift:

~~~~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"),

    ]),

~~~~

It is encouraged to use environment variables to inject the OpenAI API key, instead of hardcoding it in the source code.

~~~~bash

# .env

OPENAI_API_KEY="YOUR-API-KEY"

OPENAI_ORGANIZATION="YOUR-ORGANIZATION"

~~~~

⚠️ OpenAI strongly recommends developers of client-side applications proxy requests through a separate backend service to keep their API key safe. API keys can access and manipulate customer billing, usage, and organizational data, so it's a significant risk to [expose](https://nshipster.com/secrets/) them.

Create a `OpenAIKit.Client` by passing a configuration.

~~~~swift

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)

~~~~

If you don't want to use SwiftNIO you can use URLSession.

~~~~swift

let urlSession = URLSession(configuration: .default)

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

let openAIClient = OpenAIKit.Client(session: urlSession, configuration: configuration)

~~~~

## Using the API

The OpenAIKit.Client implements a handful of methods to interact with the OpenAI API:

~~~~swift

import OpenAIKit

let completion = try await openAIClient.completions.create(

    model: Model.GPT3.davinci,

    prompts: ["Write a haiku"]

)

~~~~

### What's Implemented

* [x] [Chat](https://platform.openai.com/docs/api-reference/chat)

* [x] [Models](https://beta.openai.com/docs/api-reference/models)

* [x] [Completions](https://beta.openai.com/docs/api-reference/completions)

* [x] [Edits](https://beta.openai.com/docs/api-reference/edits)

* [x] [Images](https://beta.openai.com/docs/api-reference/images)

* [x] [Embeddings](https://beta.openai.com/docs/api-reference/embeddings)

* [x] [Files](https://beta.openai.com/docs/api-reference/files)

* [x] [Moderations](https://beta.openai.com/docs/api-reference/moderations)

* [ ] [Fine-tunes](https://beta.openai.com/docs/api-reference/fine-tunes)

* [x] [Speech to text](https://platform.openai.com/docs/guides/speech-to-text)

* [ ] [Function calling](https://platform.openai.com/docs/guides/gpt/function-calling)

## Error handling

If the request to the API failed for any reason an `OpenAIKit.APIErrorResponse` is `thrown`.

Simply ensure you catch errors thrown like any other throwing function

~~~~swift

do {

   ...

} catch let error as APIErrorResponse {

    print(error)

}

~~~~