sendModeration endpoint

Sources/OpenAISwift/Models/Moderation.swift

@@ -0,0 +1,10 @@
+//
+//  Created by Michael Watts on 5/15/23.
+//
+
+import Foundation
+
+struct Moderation: Encodable {
+    let input: String
+    let model: String
+}

Sources/OpenAISwift/Models/OpenAI.swift

@@ -12,6 +12,7 @@ public struct OpenAI<T: Payload>: Codable {
     public let choices: [T]?
     public let usage: UsageResult?
     public let data: [T]?
+    public let results: [T]?
 }
 
 public struct TextResult: Payload {
@@ -41,3 +42,7 @@ public struct UrlResult: Payload {
 public struct EmbeddingResult: Payload {
     public let embedding: [Double]
 }
+
+public struct ModerationResult: Payload {
+    public let flagged: Bool?
+}

Sources/OpenAISwift/Models/OpenAIModelType.swift

@@ -24,6 +24,9 @@ public enum OpenAIModelType {
     /// ``Embedding`` Family of Models
     case embedding(Embedding)
 
+    /// ``Moderation`` Family of Models
+    case moderation(Moderation)
+
     /// Other Custom Models
     case other(String)
 
@@ -34,6 +37,7 @@ public enum OpenAIModelType {
         case .feature(let model): return model.rawValue
         case .chat(let model): return model.rawValue
         case .embedding(let model): return model.rawValue
+        case .moderation(let model): return model.rawValue
         case .other(let modelName): return modelName
         }
     }
@@ -115,4 +119,15 @@ public enum OpenAIModelType {
         /// > Model Name: text-embedding-ada-002
         case ada = "text-embedding-ada-002"
     }
+
+    /// A set of models for the moderations endpoint
+    /// You can read the [API Docs](https://platform.openai.com/docs/api-reference/moderations)
+    public enum Moderation: String {
+        /// Default. Automatically upgraded over time.
+        case latest = "text-moderation-latest"
+
+        /// OpenAI will provide advanced notice before updating this model.
+        /// Accuracy  may be slightly lower than for text-moderation-latest.
+        case stable = "text-moderation-stable"
+    }
 }

Sources/OpenAISwift/OpenAIEndpoint.swift

@@ -10,6 +10,7 @@ enum Endpoint {
     case chat
     case images
     case embeddings
+    case moderations
 }
 
 extension Endpoint {
@@ -24,20 +25,22 @@ extension Endpoint {
             case .images:
                 return "/v1/images/generations"
             case .embeddings:
-            return "/v1/embeddings"
+                return "/v1/embeddings"
+            case .moderations:
+                return "/v1/moderations"
         }
     }
 
     var method: String {
         switch self {
-            case .completions, .edits, .chat, .images, .embeddings:
+            case .completions, .edits, .chat, .images, .embeddings, .moderations:
             return "POST"
         }
     }
 
     func baseURL() -> String {
         switch self {
-            case .completions, .edits, .chat, .images, .embeddings:
+            case .completions, .edits, .chat, .images, .embeddings, .moderations:
             return "https://api.openai.com"
         }
     }

Sources/OpenAISwift/OpenAISwift.swift

@@ -85,6 +85,31 @@ extension OpenAISwift {
         }
     }
 
+    /// Send a Moderation request to the OpenAI API
+    /// - Parameters:
+    ///   - input: The Input For Example "My nam is Adam"
+    ///   - model: The Model to use
+    ///   - completionHandler: Returns an OpenAI Data Model
+    public func sendModerations(with input: String, model: OpenAIModelType = .moderation(.latest), completionHandler: @escaping (Result<OpenAI<ModerationResult>, OpenAIError>) -> Void) {
+        let endpoint = Endpoint.moderations
+        let body = Moderation(input: input, model: model.modelName)
+        let request = prepareRequest(endpoint, body: body)
+
+        makeRequest(request: request) { result in
+            switch result {
+            case .success(let success):
+                do {
+                    let res = try JSONDecoder().decode(OpenAI<ModerationResult>.self, from: success)
+                    completionHandler(.success(res))
+                } catch {
+                    completionHandler(.failure(.decodingError(error: error)))
+                }
+            case .failure(let failure):
+                completionHandler(.failure(.genericError(error: failure)))
+            }
+        }
+    }
+
     /// Send a Chat request to the OpenAI API
     /// - Parameters:
     ///   - messages: Array of `ChatMessages`
@@ -334,6 +359,21 @@ extension OpenAISwift {
         }
     }
 
+    /// Send a Moderation request to the OpenAI API
+    /// - Parameters:
+    ///   - input: The Input For Example "My nam is Adam"
+    ///   - model: The Model to use
+    /// - Returns: Returns an OpenAI Data Model
+    @available(swift 5.5)
+    @available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, *)
+    public func sendModerations(with input: String = "", model: OpenAIModelType = .moderation(.latest)) async throws -> OpenAI<ModerationResult> {
+        return try await withCheckedThrowingContinuation { continuation in
+            sendModerations(with: input, model: model) { result in
+                continuation.resume(with: result)
+            }
+        }
+    }
+
     /// Send a Image generation request to the OpenAI API
     /// - Parameters:
     ///   - prompt: The Text Prompt