Jan 2024 Updates

Package.swift

@@ -5,7 +5,7 @@ import PackageDescription
 
 let package = Package(
     name: "OpenAISwift",
-    platforms: [.iOS(.v15), .macOS(.v10_15)],
+    platforms: [.iOS(.v13), .macOS(.v10_15)],
     products: [
         // Products define the executables and libraries a package produces, and make them visible to other packages.
         .library(

README.md

@@ -20,14 +20,6 @@ You can use Swift Package Manager to integrate the library by adding the followi
 
 `.package(url: "https://github.com/adamrushy/OpenAISwift.git", from: "1.2.0")`
 
-### CocoaPods
-
-[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate `OpenAISwift` into your Xcode project using CocoaPods, specify it in your `Podfile`:
-
-```ruby
-pod 'OpenAISwift'
-```
-
 ### Manual
 
 Copy the source files into your own project.
@@ -40,152 +32,17 @@ Import the framework in your project:
 
 [Create an OpenAI API key](https://platform.openai.com/account/api-keys) and add it to your configuration:
 
-`let openAI = OpenAISwift(authToken: "TOKEN")`
-
-This framework supports Swift concurrency; each example below has both an async/await and completion handler variant.
-
-### [Completions](https://platform.openai.com/docs/api-reference/completions)
-
-Predict completions for input text.
-
-```swift
-openAI.sendCompletion(with: "Hello how are you") { result in // Result<OpenAI, OpenAIError>
-    switch result {
-    case .success(let success):
-        print(success.choices.first?.text ?? "")
-    case .failure(let failure):
-        print(failure.localizedDescription)
-    }
-}
-```
-
-This returns an `OpenAI` object containing the completions.
-
-Other API parameters are also supported:
-
-```swift
-do {
-    let result = try await openAI.sendCompletion(
-        with: "What's your favorite color?",
-        model: .gpt3(.davinci), // optional `OpenAIModelType`
-        maxTokens: 16,          // optional `Int?`
-        temperature: 1          // optional `Double?`
-    )
-    // use result
-} catch {
-    // ...
-}
-```
-
-For a full list of supported models, see [OpenAIModelType.swift](https://github.com/adamrushy/OpenAISwift/blob/main/Sources/OpenAISwift/Models/OpenAIModelType.swift). For more information on the models see the [OpenAI API Documentation](https://beta.openai.com/docs/models).
-
-### [Chat](https://platform.openai.com/docs/api-reference/chat)
-
-Get responses to chat conversations through ChatGPT (aka GPT-3.5) and GPT-4 (in beta).
-
-```swift
-do {
-    let chat: [ChatMessage] = [
-        ChatMessage(role: .system, content: "You are a helpful assistant."),
-        ChatMessage(role: .user, content: "Who won the world series in 2020?"),
-        ChatMessage(role: .assistant, content: "The Los Angeles Dodgers won the World Series in 2020."),
-        ChatMessage(role: .user, content: "Where was it played?")
-    ]
-
-    let result = try await openAI.sendChat(with: chat)
-    // use result
-} catch {
-    // ...
-}
-```
-
-All API parameters are supported, except streaming message content before it is completed:
-
-```swift
-do {
-    let chat: [ChatMessage] = [...]
-
-    let result = try await openAI.sendChat(
-        with: chat,
-        model: .chat(.chatgpt),         // optional `OpenAIModelType`
-        user: nil,                      // optional `String?`
-        temperature: 1,                 // optional `Double?`
-        topProbabilityMass: 1,          // optional `Double?`
-        choices: 1,                     // optional `Int?`
-        stop: nil,                      // optional `[String]?`
-        maxTokens: nil,                 // optional `Int?`
-        presencePenalty: nil,           // optional `Double?`
-        frequencyPenalty: nil,          // optional `Double?`
-        logitBias: nil                 // optional `[Int: Double]?` (see inline documentation)
-    )
-    // use result
-} catch {
-    // ...
-}
-```
-
-### [Images (DALL·E)](https://platform.openai.com/docs/api-reference/images/create)
-
-Generate an image based on a prompt.
-
-```swift
-openAI.sendImages(with: "A 3d render of a rocket ship", numImages: 1, size: .size1024) { result in // Result<OpenAI, OpenAIError>
-    switch result {
-    case .success(let success):
-        print(success.data.first?.url ?? "")
-    case .failure(let failure):
-        print(failure.localizedDescription)
-    }
-}
-```
-
-### [Edits](https://platform.openai.com/docs/api-reference/edits)
-
-Edits text based on a prompt and an instruction.
-
-```swift
-do {
-    let result = try await openAI.sendEdits(
-        with: "Improve the tone of this text.",
-        model: .feature(.davinci),               // optional `OpenAIModelType`
-        input: "I am resigning!"
-    )
-    // use result
-} catch {
-    // ...
-}
-```
-
-### [Moderation](https://platform.openai.com/docs/api-reference/moderations)
-
-Classifies text for moderation purposes (see OpenAI reference for more info).
-
-```swift
-do {
-    let result = try await openAI.sendModeration(
-        with: "Some harmful text...",
-        model: .moderation(.latest)     // optional `OpenAIModelType`
-    )
-    // use result
-} catch {
-    // ...
-}
-```
-
-### [Embeddings](https://platform.openai.com/docs/api-reference/embeddings)
-
-Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.(see OpenAI reference for more info).
-
-```swift
-do {
-    let result = try await openAI.sendEmbeddings(
-        with: "The food was delicious and the waiter..."
-    )
-    // use result
-} catch {
-    // ...
-}
-```
+let TOKEN = "sk-...... "
+
+let openAI: OpenAISwift = OpenAISwift(config: OpenAISwift.Config.makeDefaultOpenAI(apiKey: "TOKEN"))
+
+
+To follow [OpenAI requirements](https://platform.openai.com/docs/api-reference/authentication) 
+
+>  Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.
+
+and basic industrial safety you should not call OpenAI API directly. 
+
 
 ## Contribute ❤️
 

Sources/OpenAISwift/Extensions/Extensions.swift

@@ -0,0 +1,15 @@
+//
+//  File.swift
+//  
+//
+//  Created by Mark Hoath on 15/11/2023.
+//
+
+import Foundation
+
+extension Encodable {
+    func toDictionary() -> [String: Any]? {
+        guard let data = try? JSONEncoder().encode(self) else { return nil }
+        return (try? JSONSerialization.jsonObject(with: data, options: .allowFragments)).flatMap { $0 as? [String: Any] }
+    }
+}

Sources/OpenAISwift/Models/AssistantObject.swift

@@ -0,0 +1,69 @@
+//
+//  File.swift
+//  
+//
+//  Created by Mark Hoath on 15/11/2023.
+//
+
+import Foundation
+
+public struct CodeInterpretorTool: Codable {
+    public let type: String
+}
+
+public struct RetrievalTool: Codable {
+    public let type: String
+}
+
+public struct ParamJSONObject: Codable {
+    public let properties: String
+}
+
+public struct FunctionObject: Codable {
+    public let description: String
+    public let name: String
+    public let parameters: ParamJSONObject
+}
+
+public struct FunctionTool: Codable {
+    public let type: String
+    public let function: FunctionObject
+}
+
+public struct Tools: Codable {
+    public let codeInterpretorTool: CodeInterpretorTool?
+    public let retrievalTool: RetrievalTool?
+    public let functionTool: FunctionTool?
+}
+
+
+
+public struct AssistantObject: Codable {
+    public let id: String
+    public let object: String
+    public let created_at: Int
+    public let name: String?
+    public let description: String?
+    public let model: String
+    public let instructions: String?
+    public let tools: [Tools]
+    public let file_ids: [String]
+    public let metadata: [String:String]
+}
+
+public struct AssistantBody: Codable {
+    public let model: String
+    public let name: String?
+    public let description: String?
+    public let instructions: String?
+    public let tools: [Tools]?
+    public let file_ids: [String]?
+    public let metadata: [String:String]?
+}
+
+public struct ListAssistantParams: Codable {
+    public let limit: Int?
+    public let order: String?
+    public let after: String?
+    public let before: String?
+}

Sources/OpenAISwift/Models/AudioObject.swift

@@ -0,0 +1,47 @@
+//
+//  File.swift
+//  
+//
+//  Created by Mark Hoath on 14/11/2023.
+//
+
+import Foundation
+
+public enum Voice: String, Codable {
+    case alloy, echo, fable, onyx, nova, shimmer
+}
+
+public enum AudioResponseFormat: String, Codable {
+    case mp3, opus, aac, flac
+}
+
+public enum TranscriptionResponseFormat: String, Codable {
+    case json, text, srt, verbose_json, vtt
+}
+
+public struct Audio: Encodable {
+    public let model: String
+    public let input: String
+    public let voice: Voice
+    public let response_format: AudioResponseFormat?
+    public let speed: Double?
+}
+
+public struct Transcription: Encodable {
+    public let file: String
+    public let model: String
+    public let language: String?
+    public let prompt: String?
+    public let response_format: TranscriptionResponseFormat?
+    public let temperature: Double?
+
+}
+
+public struct Translation: Encodable {
+    public let file: String
+    public let model: String
+    public let prompt: String?
+    public let response_format: TranscriptionResponseFormat?
+    public let temperature: Double?
+}
+