Size enum for ImagesQuery

Demo/DemoChat/Sources/UI/Images/ImageCreationView.swift

@@ -13,9 +13,9 @@ public struct ImageCreationView: View {
 
     @State private var prompt: String = ""
     @State private var n: Int = 1
-    @State private var size: String
-    
-    private var sizes = ["256x256", "512x512", "1024x1024"]
+    @State private var size: ImagesQuery.Size
+
+    private var sizes = ImagesQuery.Size.allCases
 
     public init(store: ImageStore) {
         self.store = store
@@ -37,7 +37,7 @@ public struct ImageCreationView: View {
                 HStack {
                     Picker("Size", selection: $size) {
                         ForEach(sizes, id: \.self) {
-                            Text($0)
+                            Text($0.rawValue)
                         }
                     }
                 }

Sources/OpenAI/Public/Models/ImagesQuery.swift

@@ -26,15 +26,15 @@ public struct ImagesQuery: Codable {
     /// The number of images to generate. Must be between 1 and 10.
     public let n: Int?
     /// The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
-    public let size: String?
+    public let size: Self.Size?
     /// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
     public let user: String?
     /// The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.
     public let style: String?
     /// The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.
     public let quality: String?
 
-    public init(prompt: String, model: Model?=nil, responseFormat: Self.ResponseFormat?=nil, n: Int?, size: String?, style: String?=nil, user:String?=nil, quality:String?=nil) {
+    public init(prompt: String, model: Model?=nil, responseFormat: Self.ResponseFormat?=nil, n: Int?, size: Self.Size?, style: String?=nil, user:String?=nil, quality:String?=nil) {
         self.style = style
         self.prompt = prompt
         self.n = n
@@ -55,4 +55,13 @@ public struct ImagesQuery: Codable {
         case responseFormat = "response_format"
         case quality
     }
+
+    public enum Size: String, Codable, CaseIterable {
+        case _256 = "256x256"
+        case _512 = "512x512"
+        case _1024 = "1024x1024"
+        //case _1792_1024 = "1792x1024" // for dall-e-3 models
+        //case _1024_1792 = "1024x1792" // for dall-e-3 models
+
+    }
 }

Sources/OpenAI/Public/Protocols/OpenAIProtocol.swift

@@ -49,7 +49,7 @@ public protocol OpenAIProtocol {
 
      Example:
      ```
-     let query = ImagesQuery(prompt: "White cat with heterochromia sitting on the kitchen table", n: 1, size: "1024x1024")
+     let query = ImagesQuery(prompt: "White cat with heterochromia sitting on the kitchen table", n: 1, size: ImagesQuery.Size._1024)
      openAI.images(query: query) { result in
        //Handle result here
      }
@@ -66,7 +66,7 @@ public protocol OpenAIProtocol {
 
      Example:
      ```
-     let query = ImagesEditQuery(image: "@whitecat.png", prompt: "White cat with heterochromia sitting on the kitchen table with a bowl of food", n: 1, size: "1024x1024")
+     let query = ImagesEditQuery(image: "@whitecat.png", prompt: "White cat with heterochromia sitting on the kitchen table with a bowl of food", n: 1, size: ImagesQuery.Size._1024)
      openAI.imageEdits(query: query) { result in
        //Handle result here
      }
@@ -83,7 +83,7 @@ public protocol OpenAIProtocol {
 
      Example:
      ```
-     let query = ImagesVariationQuery(image: "@whitecat.png", n: 1, size: "1024x1024")
+     let query = ImagesVariationQuery(image: "@whitecat.png", n: 1, size: ImagesQuery.Size._1024)
      openAI.imageVariations(query: query) { result in
        //Handle result here
      }

Tests/OpenAITests/OpenAITests.swift

@@ -44,7 +44,7 @@ class OpenAITests: XCTestCase {
     }
 
     func testImages() async throws {
-        let query = ImagesQuery(prompt: "White cat with heterochromia sitting on the kitchen table", model: .dall_e_2, n: 1, size: "1024x1024")
+        let query = ImagesQuery(prompt: "White cat with heterochromia sitting on the kitchen table", model: .dall_e_2, n: 1, size: ._1024)
         let imagesResult = ImagesResult(created: 100, data: [
             .init(url: "http://foo.bar", b64_json: nil)
         ])
@@ -54,7 +54,7 @@ class OpenAITests: XCTestCase {
     }
 
     func testImagesError() async throws {
-        let query = ImagesQuery(prompt: "White cat with heterochromia sitting on the kitchen table", n: 1, size: "1024x1024")
+        let query = ImagesQuery(prompt: "White cat with heterochromia sitting on the kitchen table", n: 1, size: ._1024)
         let inError = APIError(message: "foo", type: "bar", param: "baz", code: "100")
         self.stub(error: inError)
 

Tests/OpenAITests/OpenAITestsDecoder.swift

@@ -117,7 +117,7 @@ class OpenAITestsDecoder: XCTestCase {
             model: .dall_e_2,
             responseFormat: .b64_json,
             n: 1,
-            size: "10",
+            size: ._512,
             style: "vivid",
             user: "user"
         )
@@ -127,7 +127,7 @@ class OpenAITestsDecoder: XCTestCase {
             "model": "dall-e-2",
             "prompt": "test",
             "n": 1,
-            "size": "10",
+            "size": "512x512",
             "style": "vivid",
             "user": "user",
             "response_format": "b64_json"