Implementation of Endpoints for Image Edit and Image Variation

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

@@ -40,7 +40,39 @@ 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")`
+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. 
+
+```swift
+private lazy var proxyOpenAIBackend: OpenAISwift = .init(
+        config: OpenAISwift.Config(
+            baseURL: "http://localhost",
+            endpointPrivider: OpenAIEndpointProvider(source: .proxy(path: { _ -> String in
+                "/chat/completions"
+            }, method: { _ -> String in
+                "POST"
+            })),
+            session: session,
+            authorizeRequest: { [weak self] request in
+                self?.authorizeRequest(&request)
+            }
+        ))
+
+    private func authorizeRequest(_ request: inout URLRequest) {
+        if let apiKey = try? Encryptor.getApiToken() {
+            request.setValue(apiKey, forHTTPHeaderField: "X-API-KEY")
+        }
+    }
+```
+
 
 This framework supports Swift concurrency; each example below has both an async/await and completion handler variant.
 

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?
+}
+

Sources/OpenAISwift/Models/ChatMessage.swift

@@ -18,9 +18,12 @@ public enum ChatRole: String, Codable {
 }
 
 /// A structure that represents a single message in a chat conversation.
+
 public struct ChatMessage: Codable, Identifiable {
-    // uuid to conform to Identifiable protocol
+    /// UUID to conform to the Identifiable protocol
+    /// - Note: This property is not de- and encoded. A DTO or other logic might be required if the `ChatMessage` instance is stored locally.
     public var id = UUID()
+
     /// The role of the sender of the message.
     public let role: ChatRole?
     /// The content of the message.
@@ -34,6 +37,39 @@ public struct ChatMessage: Codable, Identifiable {
         self.role = role
         self.content = content
     }
+
+    enum CodingKeys: CodingKey {
+        case id
+        case role
+        case content
+    }
+
+    public init(from decoder: Decoder) throws {
+        let container: KeyedDecodingContainer<ChatMessage.CodingKeys> = try decoder.container(keyedBy: ChatMessage.CodingKeys.self)
+
+
+        self.id = UUID()
+        self.role = try container.decodeIfPresent(ChatRole.self, forKey: ChatMessage.CodingKeys.role)
+        self.content = try container.decodeIfPresent(String.self, forKey: ChatMessage.CodingKeys.content)
+
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container: KeyedEncodingContainer<ChatMessage.CodingKeys> = encoder.container(keyedBy: ChatMessage.CodingKeys.self)
+
+        try container.encodeIfPresent(self.role, forKey: ChatMessage.CodingKeys.role)
+        try container.encodeIfPresent(self.content, forKey: ChatMessage.CodingKeys.content)
+
+    }
+}
+
+extension ChatMessage:  Equatable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(id)
+    }
+    public static func == (lhs: ChatMessage, rhs: ChatMessage) -> Bool {
+        return lhs.id == rhs.id
+    }
 }
 
 /// A structure that represents a chat conversation.
@@ -70,7 +106,7 @@ public struct ChatConversation: Encodable {
 
     /// Modify the likelihood of specified tokens appearing in the completion. Maps tokens (specified by their token ID in the OpenAI Tokenizer—not English words) to an associated bias value from -100 to 100. Values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
     let logitBias: [Int: Double]?
-    
+
     /// If you're generating long completions, waiting for the response can take many seconds. To get responses sooner, you can 'stream' the completion as it's being generated. This allows you to start printing or processing the beginning of the completion before the full completion is finished.
     /// https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb
     let stream: Bool?
@@ -96,6 +132,6 @@ public struct ChatError: Codable {
         public let message, type: String
         public let param, code: String?
     }
-    
+
     public let error: Payload
 }

Sources/OpenAISwift/Models/FilesObject.swift

@@ -0,0 +1,31 @@
+//
+//  File.swift
+//  
+//
+//  Created by Mark Hoath on 14/11/2023.
+//
+
+import Foundation
+
+
+public enum FilePurpose: String, Codable {
+    case fine_tune = "fine-tune", fine_tune_results = "fine-tune-results", assistants, assistants_output = "assistants-output"
+}
+
+public struct FilesResquest: Codable {
+    public let purpose: String?
+}
+
+public struct FileUploadResquest: Codable {
+    public let file: Data
+    public let purpose: String
+}
+
+public struct FilesModel: Codable {
+    public var id: String
+    public var bytes: Int
+    public var created_at: Int
+    public var filename: String
+    public var object: String = "file"
+    public var purpose: FilePurpose?
+}

Sources/OpenAISwift/Models/FineTuningObject.swift

@@ -0,0 +1,61 @@
+//
+//  File.swift
+//  
+//
+//  Created by Mark Hoath on 15/11/2023.
+//
+
+import Foundation
+
+
+public struct FineTuningError: Codable {
+    public let code: String
+    public let message: String
+    public let param: String?
+}
+
+public struct FineTuningHyperParams: Codable {
+    public let batch_size: String?
+    public let learning_rate_multiplier: String?
+    public let n_epochs: String?
+}
+
+public struct FineTuning: Codable {
+
+    public let id: String
+    public let created_at: Int
+    public let error: FineTuningError?
+    public let fine_tuned_model: String?
+    public let finished_at: Int
+    public let hyperparameters: FineTuningHyperParams?
+    public let model: String
+    public let object: String
+    public let organization_id: String
+    public let results_files: [String]
+    public let status: String
+    public let trained_tokens: Int?
+    public let training_file: String
+    public let validation_file: String?
+}
+
+public struct FineTuningRequest: Codable {
+    public let model: String
+    public let training_file: String
+    public let hyperparameters: FineTuningHyperParams?
+    public let suffix: String?
+    public let validation_file: String?
+}
+
+public struct FineTuningListRequest: Codable {
+    public let after: String?
+    public let limit: Int?
+}
+
+public struct FineTuningEvent: Codable {
+    public let id: String
+    public let created_at: Int
+    public let level: String
+    public let message: String
+    public let object: String
+}
+

Sources/OpenAISwift/Models/ImageGeneration.swift

@@ -14,6 +14,22 @@ struct ImageGeneration: Encodable {
     let user: String?
 }
 
+struct ImageEdit: Encodable {
+    let image: Data
+    let mask: Data?
+    let prompt: String
+    let n: Int
+    let size: ImageSize
+    let user: String?
+}
+
+struct ImageVariations: Encodable {
+    let image: Data
+    let n: Int
+    let size: ImageSize
+    let user: String?
+}
+
 public enum ImageSize: String, Codable {
     case size1024 = "1024x1024"
     case size512 = "512x512"

Sources/OpenAISwift/Models/MessageFileObject.swift

@@ -0,0 +1,15 @@
+//
+//  File.swift
+//  
+//
+//  Created by Mark Hoath on 16/11/2023.
+//
+
+import Foundation
+
+public struct MessageFileObject: Codable {
+    public let id: String
+    public let object: String
+    public let created_at: Int
+    public let message_id: String
+}