ChatGPTSwift - GitLite

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #go #android #machine-learning #deep-learning #linux #macos #nodejs #windows #pytorch #ios #mcp

ChatGPTSwift

(★ 697)

Access ChatGPT API using Swift

File Explorer

Download Latest Version (.zip)

- launch.json
- settings.json
- - AuthMiddleware.swift
  - ChatGPTAPI.swift
  - Models.swift
  - openapi-generator-config.yaml
  - openapi.yaml
  - String+Error.swift
  - URLSessionMultipart.swift
- - main.swift
- - ChatGPTSwiftTests.swift
.gitignore
ChatGPTSwift.podspec
docker-compose.yml
LICENSE
Package.resolved
Package.swift
README.md

🚀 Installation Guide

1. Get the code

git clone https://github.com/alfianlosari/ChatGPTSwift

Downloads the entire project code from GitHub to your computer.

cd ChatGPTSwift

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ChatGPTSwift API

![Alt text](https://imagizer.imageshack.com/v2/640x480q90/923/c9MPBA.png "image")

Access OpenAI ChatGPT Official API using Swift. Works on all Apple platforms.

## Supported Platforms

- iOS/tvOS 15 and above
- macOS 12 and above
- watchOS 8 and above
- Linux

## Installation

### Swift Package Manager
- File > Swift Packages > Add Package Dependency
- Add https://github.com/alfianlosari/ChatGPTSwift.git

### Cocoapods
```ruby
platform :ios, '15.0'
use_frameworks!

target 'MyApp' do
  pod 'ChatGPTSwift', '~> 2.5.0'
end
```

## Requirement

Register for API key from [OpenAI](https://openai.com/api). Initialize with api key

```swift
let api = ChatGPTAPI(apiKey: "API_KEY")
```

## Usage

There are 2 APIs: stream and normal

### Stream

The server will stream chunks of data until complete, the method `AsyncThrowingStream` which you can loop using For-Loop like so:

```swift
Task {
    do {
        let stream = try await api.sendMessageStream(text: "What is ChatGPT?")
        for try await line in stream {
            print(line)
        }
    } catch {
        print(error.localizedDescription)
    }
}
```

### Normal
A normal HTTP request and response lifecycle. Server will send the complete text (it will take more time to response)

```swift
Task {
    do {
        let response = try await api.sendMessage(text: "What is ChatGPT?")
        print(response)
    } catch {
        print(error.localizedDescription)
    }
}
        
```

### Providing extra parameters

Optionally, you can provide the model, system prompt, temperature, and model like so.

```swift
let response = try await api.sendMessage(text: "What is ChatGPT?",
                                         model: "gpt-4",
                                         systemText: "You are a CS Professor",
                                         temperature: 0.5)
```

Default values for these parameters are:
- model: `gpt-3.5-turbo`
- systemText: `You're a helpful assistant`
- temperature: `0.5`

To learn more about those parameters, you can visit the official [ChatGPT API documentation](https://platform.openai.com/docs/guides/chat/introduction) and [ChatGPT API Introduction Page](https://openai.com/blog/introducing-chatgpt-and-whisper-apis)

## History List

The client stores the history list of the conversation that will be included in the new prompt so ChatGPT aware of the previous context of conversation. When sending new prompt, the client will make sure the token count is not exceeding 4096 using [GPTEncoder library](https://github.com/alfianlosari/GPTEncoder) to calculate tokens in string, in case it exceeded the token, some of previous conversations will be truncated. In future i will provide an API to specify the token threshold as new gpt-4 model accept much bigger 8k tokens in a prompt.

### View Current History List

You can view current history list from the `historyList` property.

```swift
print(api.historyList)
```

### Delete History List

You can also delete the history list by invoking

```swift
api.deleteHistoryList()
```

### Replace History List

You can provide your own History List, this will replace the stored history list. Remember not to pass the 4096 tokens threshold.

```swift
let myHistoryList = [
    Message(role: "user", content: "who is james bond?")
    Message(role: "assistant", content: "secret british agent with codename 007"),
    Message(role: "user", content: "which one is the latest movie?"),
    Message(role: "assistant", content: "It's No Time to Die played by Daniel Craig")
]

api.replaceHistoryList(with: myHistoryList)
```

## GPT Encoder Lib
I've also created [GPTEncoder](https://github.com/alfianlosari/GPTEncoder) Swift BPE Encoder/Decoder for OpenAI GPT Models. A programmatic interface for tokenizing text for OpenAI GPT API.

## GPT Tokenizer UI Lib
I've also created [GPTTokenizerUI](https://github.com/alfianlosari/GPTTokenizerUI), a SPM lib you can integrate in your app for providing GUI to input text and show the tokenization results used by GPT API.

![Alt text](https://imagizer.imageshack.com/v2/640x480q70/922/CEVvrE.png "image")

## Demo Apps
You can check the demo apps for iOS and macOS from the [SwiftUIChatGPT repo](https://github.com/alfianlosari/ChatGPTSwiftUI)