OpenAI Component (#2)

CITATION.cff

@@ -12,6 +12,9 @@ authors:
 - family-names: "Schmiedmayer"
   given-names: "Paul"
   orcid: "https://orcid.org/0000-0002-8607-9148"
+- family-names: "Ravi"
+  given-names: "Vishnu"
+  orcid: "https://orcid.org/0000-0003-0359-1275"
 title: "SpeziML"
 doi: 10.5281/zenodo.7538165
 url: "https://github.com/StanfordSpezi/SpeziML"

CONTRIBUTORS.md

@@ -14,3 +14,4 @@ SpeziML contributors
 ====================
 
 * [Paul Schmiedmayer](https://github.com/PSchmiedmayer)
+* [Vishnu Ravi](https://github.com/vishnuravi)

Package.swift

@@ -17,16 +17,27 @@ let package = Package(
         .iOS(.v16)
     ],
     products: [
-        .library(name: "SpeziML", targets: ["SpeziML"])
+        .library(name: "SpeziOpenAI", targets: ["SpeziOpenAI"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/MacPaw/OpenAI", .upToNextMinor(from: "0.2.1")),
+        .package(url: "https://github.com/StanfordSpezi/Spezi", .upToNextMinor(from: "0.5.0")),
+        .package(url: "https://github.com/StanfordSpezi/SpeziStorage", .upToNextMinor(from: "0.3.1"))
     ],
     targets: [
         .target(
-            name: "SpeziML"
+            name: "SpeziOpenAI",
+            dependencies: [
+                .product(name: "OpenAI", package: "OpenAI"),
+                .product(name: "Spezi", package: "Spezi"),
+                .product(name: "SpeziLocalStorage", package: "SpeziStorage"),
+                .product(name: "SpeziSecureStorage", package: "SpeziStorage")
+            ]
         ),
         .testTarget(
-            name: "SpeziMLTests",
+            name: "SpeziOpenAITests",
             dependencies: [
-                .target(name: "SpeziML")
+                .target(name: "SpeziOpenAI")
             ]
         )
     ]

Sources/SpeziOpenAI/OpenAIComponent.swift

@@ -0,0 +1,81 @@
+//
+// This source file is part of the Stanford Spezi open source project
+//
+// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+
+import OpenAI
+import Spezi
+import SpeziLocalStorage
+import SpeziSecureStorage
+import SwiftUI
+
+
+/// `OpenAIComponent` is a module responsible for to coordinate the interactions with the OpenAI GPT API.
+public class OpenAIComponent<ComponentStandard: Standard>: Component, ObservableObject, ObservableObjectProvider {
+    @Dependency private var localStorage: LocalStorage
+    @Dependency private var secureStorage: SecureStorage
+
+    /// The OpenAI GPT Model type that is used to interact with the OpenAI API
+    @AppStorage(OpenAIConstants.modelStorageKey) public var openAIModel: Model = .gpt3_5Turbo
+    private var defaultAPIToken: String?
+
+    /// The API token used to interact with the OpenAI API
+    public var apiToken: String? {
+        get {
+            try? secureStorage.retrieveCredentials(OpenAIConstants.credentialsUsername, server: OpenAIConstants.credentialsServer)?.password
+        }
+        set {
+            objectWillChange.send()
+            if let newValue {
+                try? secureStorage.store(
+                    credentials: Credentials(username: OpenAIConstants.credentialsUsername, password: newValue),
+                    server: OpenAIConstants.credentialsServer
+                )
+            } else {
+                try? secureStorage.deleteCredentials(OpenAIConstants.credentialsUsername, server: OpenAIConstants.credentialsServer)
+            }
+        }
+    }
+
+
+    /// Initializes a new instance of `OpenAIGPT` with the specified API token and OpenAI model.
+    ///
+    /// - Parameters:
+    ///   - apiToken: The API token for the OpenAI API.
+    ///   - openAIModel: The OpenAI model to use for querying.
+    public init(apiToken: String? = nil, openAIModel model: Model? = nil) {
+        if UserDefaults.standard.object(forKey: OpenAIConstants.modelStorageKey) == nil {
+            self.openAIModel = openAIModel
+        }
+
+        defaultAPIToken = apiToken
+    }
+
+
+    public func configure() {
+        if self.apiToken == nil, let defaultAPIToken {
+            self.apiToken = defaultAPIToken
+        }
+    }
+
+
+    /// Queries the OpenAI API using the provided messages.
+    ///
+    /// - Parameters:
+    ///   - messages: A collection of chat  messages used in the conversation.
+    ///
+    /// - Returns: The content of the response from the API.
+    public func queryAPI(withChat chat: [Chat]) async throws -> AsyncThrowingStream<ChatStreamResult, Error> {
+        guard let apiToken, !apiToken.isEmpty else {
+            throw OpenAIError.noAPIToken
+        }
+
+        let openAIClient = OpenAI(apiToken: apiToken)
+        let query = ChatQuery(model: openAIModel, messages: chat)
+        return openAIClient.chatsStream(query: query)
+    }
+}

Sources/SpeziOpenAI/OpenAIConstants.swift

@@ -0,0 +1,14 @@
+//
+// This source file is part of the Stanford Spezi open source project
+//
+// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+
+enum OpenAIConstants {
+    static let modelStorageKey = "OpenAIGPT.Model"
+    static let credentialsServer = "openapi.org"
+    static let credentialsUsername = "OpenAIGPT"
+}

Sources/SpeziOpenAI/OpenAIError.swift

@@ -0,0 +1,14 @@
+//
+// This source file is part of the Stanford Spezi open source project
+//
+// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+
+/// An error that can appear from an API call to the OpenAI API.
+public enum OpenAIError: Error {
+    /// There was no OpenAI API token provided.
+    case noAPIToken
+}

Sources/SpeziOpenAI/SpeziOpenAI.docc/SpeziOpenAI.md

@@ -0,0 +1,53 @@
+# ``SpeziOpenAI``
+
+<!--
+#
+# This source file is part of the Stanford Spezi open source project
+#
+# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+#
+# SPDX-License-Identifier: MIT
+#       
+-->
+
+Module to interact with the OpenAI API to interact with GPT-based large language models (LLMs).
+
+## Configuration
+
+```
+class ExampleDelegate: SpeziAppDelegate {
+    override var configuration: Configuration {
+        Configuration(standard: /* ... */) {
+            OpenAIComponent()
+            // ...
+        }
+    }
+}
+```
+
+You can provide a default API token or model configuration to the OpenAI component's ``OpenAIComponent/init(apiToken:openAIModel:)`` initializer in the configuration.
+The choice of model and the API key are persisted across application launches.
+
+
+## Usage
+
+The ``OpenAIComponent`` can subsequentially be used in a SwiftUI View using the environment dependency injection mechanism.
+
+```
+struct ExampleOpenAIView: View {
+    @EnvironmentObject var openAI: OpenAIComponent</* ... */>
+
+    // ...
+}
+```
+
+The ``OpenAIComponent``'s ``OpenAIComponent/apiToken`` and ``OpenAIComponent/openAIModel`` can be accessed and changed at runtime.
+The ``OpenAIComponent/queryAPI(withChat:)`` function allows the interaction with the GPT-based OpenAI models.
+
+
+## Types
+
+### Open AI GPT
+
+- ``OpenAIGPT``
+- ``OpenAIGPTError``

Tests/SpeziMLTests/SpeziMLTests.swift → Tests/SpeziOpenAITests/SpeziOpenAITests.swift

@@ -6,13 +6,12 @@
 // SPDX-License-Identifier: MIT
 //
 
-@testable import SpeziML
+@testable import SpeziOpenAI
 import XCTest
 
 
-final class SpeziMLTests: XCTestCase {
-    func testSpeziML() throws {
-        let speziML = SpeziML()
-        XCTAssertEqual(speziML.stanford, "Stanford University")
+final class SpeziOpenAITests: XCTestCase {
+    func testSpeziOpenAITests() throws {
+        XCTAssert(true)
     }
 }

Tests/UITests/TestApp/ContentView.swift

@@ -0,0 +1,28 @@
+//
+// This source file is part of the SpeziML open-source project
+//
+// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+import SpeziOpenAI
+import SwiftUI
+import XCTSpezi
+
+
+struct ContentView: View {
+    @EnvironmentObject var openAI: OpenAIComponent<TestAppStandard>
+
+
+    var body: some View {
+        Text("Your token is: \(openAI.apiToken ?? "")")
+        Text("Your choice of model is: \(openAI.openAIModel)")
+        Button("Test Token Change") {
+            openAI.apiToken = "New Token"
+        }
+        Button("Test Model Change") {
+            openAI.openAIModel = .gpt4
+        }
+    }
+}

Tests/UITests/TestApp/TestApp.swift

@@ -6,15 +6,18 @@
 // SPDX-License-Identifier: MIT
 //
 
-import SpeziML
 import SwiftUI
 
 
 @main
 struct UITestsApp: App {
+    @UIApplicationDelegateAdaptor(TestAppDelegate.self) var appDelegate
+
+
     var body: some Scene {
         WindowGroup {
-            Text(SpeziML().stanford)
+            ContentView()
+                .spezi(appDelegate)
         }
     }
 }

Tests/UITests/TestApp/TestAppDelegate.swift

@@ -0,0 +1,20 @@
+//
+// This source file is part of the SpeziML open-source project
+//
+// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+import Spezi
+import SpeziOpenAI
+import XCTSpezi
+
+
+class TestAppDelegate: SpeziAppDelegate {
+    override var configuration: Configuration {
+        Configuration(standard: TestAppStandard()) {
+            OpenAIComponent()
+        }
+    }
+}

Tests/UITests/TestAppUITests/TestAppUITests.swift

@@ -7,19 +7,41 @@
 //
 
 import XCTest
+import XCTestExtensions
 
 
 class TestAppUITests: XCTestCase {
     override func setUpWithError() throws {
         try super.setUpWithError()
 
         continueAfterFailure = false
+
+        let app = XCUIApplication()
+        app.deleteAndLaunch(withSpringboardAppName: "TestApp")
     }
 
 
     func testSpeziML() throws {
         let app = XCUIApplication()
+
+        XCTAssert(app.staticTexts["Your token is: "].waitForExistence(timeout: 2))
+        XCTAssert(app.staticTexts["Your choice of model is: gpt-3.5-turbo"].waitForExistence(timeout: 2))
+
+        app.buttons["Test Token Change"].tap()
+        XCTAssert(app.staticTexts["Your token is: New Token"].waitForExistence(timeout: 2))
+
+        app.buttons["Test Model Change"].tap()
+        XCTAssert(app.staticTexts["Your choice of model is: gpt-4"].waitForExistence(timeout: 2))
+
+        app.terminate()
         app.launch()
-        XCTAssert(app.staticTexts["Stanford University"].waitForExistence(timeout: 0.1))
+
+        XCTAssert(app.staticTexts["Your token is: New Token"].waitForExistence(timeout: 2))
+        XCTAssert(app.staticTexts["Your choice of model is: gpt-4"].waitForExistence(timeout: 2))
+
+        app.deleteAndLaunch(withSpringboardAppName: "TestApp")
+
+        XCTAssert(app.staticTexts["Your token is: New Token"].waitForExistence(timeout: 2))
+        XCTAssert(app.staticTexts["Your choice of model is: gpt-3.5-turbo"].waitForExistence(timeout: 2))
     }
 }