OpenAISwift

main

This is a wrapper library around the ChatGPT and OpenAI HTTP API
adamrushy/OpenAISwift

GitHub Workflow Status (with branch)

Twitter Follow

OpenAI API Client Library in Swift

This is a community-maintained library to access OpenAI HTTP API's. The full API docs can be found here: https://beta.openai.com/docs

Installation 💻

Manual

Copy source files into your own project

Swift Package Manager (Preferred)

You can use Swift Package Manager to integrate the library by adding the following dependency in your Package.swift file or by adding directly within Xcode

.Package(url: "https://github.com/adamrushy/OpenAISwift.git", majorVersion: 1)

Example Usage 🤩

Import the module in your application.

import OpenAISwift

Set your API token from creating one here.

let openAI = OpenAISwift(authToken: "TOKEN")

Create a call to the completions API, passing in a text prompt.

openAI.sendCompletion(with: "Hello how are you", maxTokens: 100) { result in // Result<OpenAI, OpenAIError>
    switch result {
    case .success(let success):
        print(success.choices.first?.text ?? "")
    case .failure(let failure):
        print(failure.localizedDescription)
    }
}

The API will return an OpenAPI object containing the corresponding text items.

You can also specify a different model to use for the completions. The sendCompletion method uses the text-davinci-003 model by default.

openAI.sendCompletion(with: "A random emoji", model: .gpt3(.ada)) { result in // Result<OpenAI, OpenAIError>
    // switch on result to get the response or error
}

For a full list of the supported models see OpenAIModelType.swift. For more information on the models see the OpenAI API Documentation.

OpenAISwift also supports Swift concurrency so you can use Swift’s async/await syntax to fetch completions.

do {
    let result = try await openAPI.sendCompletion(with: "A random emoji")
} catch {
    print(error.localizedDescription)
}

Contribute ❤️

I created this mainly for fun, we can add more endpoints and explore the library even further. Feel free to raise a PR to help grow the library.

Licence 📥

The MIT License (MIT)

Copyright (c) 2022 Adam Rush

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Description

  • Swift Tools 5.5.0
View More Packages from this Author

Dependencies

  • None
Last updated: Sun Jan 29 2023 02:23:35 GMT-0500 (GMT-05:00)