Add Speech to text support

Author: dylanshine

Package.swift

@@ -34,6 +34,8 @@ let package = Package(
             resources: [
                 .copy("Resources/logo.png"),
                 .copy("Resources/example.jsonl"),
+                .copy("Resources/9000.mp3"),
+                .copy("Resources/cena.mp3"),
             ]
         ),
     ]

README.md

@@ -70,7 +70,7 @@ let completion = try await openAIClient.completions.create(
 * [x] [Files](https://beta.openai.com/docs/api-reference/files)
 * [x] [Moderations](https://beta.openai.com/docs/api-reference/moderations)
 * [ ] [Fine-tunes](https://beta.openai.com/docs/api-reference/fine-tunes)
-* [ ] [Speech to text](https://platform.openai.com/docs/guides/speech-to-text)
+* [x] [Speech to text](https://platform.openai.com/docs/guides/speech-to-text)
 
 
 ## Error handling

Sources/OpenAIKit/Audio/Audio.swift

@@ -0,0 +1,22 @@
+//
+//  Audio.swift
+//  
+//
+//  Created by Dylan Shine on 3/19/23.
+//
+
+
+import Foundation
+
+/**
+ Audio
+ Learn how to turn audio into text.
+
+ Related guide: https://platform.openai.com/docs/guides/speech-to-text
+ */
+
+public struct Audio {
+    public let text: String
+}
+
+extension Audio: Codable {}

Sources/OpenAIKit/Audio/AudioProvider.swift

@@ -0,0 +1,81 @@
+//
+//  AudioProvider.swift
+//  
+//
+//  Created by Dylan Shine on 3/19/23.
+//
+
+import Foundation
+
+public struct AudioProvider {
+    
+    private let requestHandler: RequestHandler
+    
+    init(requestHandler: RequestHandler) {
+        self.requestHandler = requestHandler
+    }
+    
+    /**
+     Create transcription BETA
+     POST
+      
+     https://api.openai.com/v1/audio/transcriptions
+
+     Transcribes audio into the input language.
+     */
+    public func transcribe(
+        file: Data,
+        fileName: String,
+        mimeType: MIMEType.Audio,
+        model: ModelID = Model.Whisper.whisper1,
+        prompt: String? = nil,
+        responseFormat: String? = nil,
+        temperature: Double? = nil,
+        language: Language? = nil
+    ) async throws -> Audio {
+        
+        let request = CreateTranscriptionRequest(
+            file: file,
+            fileName: fileName,
+            mimeType: mimeType,
+            model: model,
+            prompt: prompt,
+            responseFormat: responseFormat,
+            temperature: temperature,
+            language: language
+        )
+        
+        return try await requestHandler.perform(request: request)
+    }
+    
+    /**
+     Create translation BETA
+     POST
+      
+     https://api.openai.com/v1/audio/translations
+
+     Translates audio into into English.
+     */
+    public func translate(
+        file: Data,
+        fileName: String,
+        mimeType: MIMEType.Audio,
+        model: ModelID = Model.Whisper.whisper1,
+        prompt: String? = nil,
+        responseFormat: String? = nil,
+        temperature: Double? = nil
+    ) async throws -> Audio {
+        
+        let request = CreateTranslationRequest(
+            file: file,
+            fileName: fileName,
+            mimeType: mimeType,
+            model: model,
+            prompt: prompt,
+            responseFormat: responseFormat,
+            temperature: temperature
+        )
+        
+        return try await requestHandler.perform(request: request)
+    }
+}

Sources/OpenAIKit/Audio/CreateTranscriptionRequest.swift

@@ -0,0 +1,64 @@
+//
+//  CreateTranscriptionRequest.swift
+//  
+//
+//  Created by Dylan Shine on 3/19/23.
+//
+
+import NIOHTTP1
+import Foundation
+import AsyncHTTPClient
+
+struct CreateTranscriptionRequest: Request {
+    let method: HTTPMethod = .POST
+    let path = "/v1/audio/transcriptions"
+    let body: HTTPClient.Body?
+    private let boundary = UUID().uuidString
+    
+    var headers: HTTPHeaders {
+        var headers = HTTPHeaders()
+        headers.add(name: "Content-Type", value: "multipart/form-data; boundary=\(boundary)")
+        return headers
+    }
+    
+    init(
+        file: Data,
+        fileName: String,
+        mimeType: MIMEType.Audio,
+        model: ModelID,
+        prompt: String?,
+        responseFormat: String?,
+        temperature: Double?,
+        language: Language?
+    ) {
+        let builder = MultipartFormDataBuilder(boundary: boundary)
+        
+        builder.addDataField(
+            fieldName:  "file",
+            fileName: fileName,
+            data: file,
+            mimeType: mimeType.rawValue
+        )
+        
+        builder.addTextField(named: "model", value: model.id)
+        
+        if let prompt = prompt {
+            builder.addTextField(named: "prompt", value: prompt)
+        }
+        
+        if let responseFormat = responseFormat {
+            builder.addTextField(named: "response_format", value: responseFormat)
+        }
+        
+        if let temperature = temperature {
+            builder.addTextField(named: "temperature", value: String(temperature))
+        }
+        
+        if let language = language {
+            builder.addTextField(named: "language", value: language.rawValue)
+        }
+
+        self.body = .data(builder.build())
+    }
+}
+

Sources/OpenAIKit/Audio/CreateTranslationRequest.swift

@@ -0,0 +1,58 @@
+//
+//  CreateTranslationRequest.swift
+//  
+//
+//  Created by Dylan Shine on 3/19/23.
+//
+
+import NIOHTTP1
+import Foundation
+import AsyncHTTPClient
+
+struct CreateTranslationRequest: Request {
+    let method: HTTPMethod = .POST
+    let path = "/v1/audio/translations"
+    let body: HTTPClient.Body?
+    private let boundary = UUID().uuidString
+    
+    var headers: HTTPHeaders {
+        var headers = HTTPHeaders()
+        headers.add(name: "Content-Type", value: "multipart/form-data; boundary=\(boundary)")
+        return headers
+    }
+    
+    init(
+        file: Data,
+        fileName: String,
+        mimeType: MIMEType.Audio,
+        model: ModelID,
+        prompt: String?,
+        responseFormat: String?,
+        temperature: Double?
+    ) {
+        let builder = MultipartFormDataBuilder(boundary: boundary)
+        
+        builder.addDataField(
+            fieldName:  "file",
+            fileName: fileName,
+            data: file,
+            mimeType: mimeType.rawValue
+        )
+        
+        builder.addTextField(named: "model", value: model.id)
+        
+        if let prompt = prompt {
+            builder.addTextField(named: "prompt", value: prompt)
+        }
+        
+        if let responseFormat = responseFormat {
+            builder.addTextField(named: "response_format", value: responseFormat)
+        }
+        
+        if let temperature = temperature {
+            builder.addTextField(named: "temperature", value: String(temperature))
+        }
+        
+        self.body = .data(builder.build())
+    }
+}

Sources/OpenAIKit/Client/Client.swift

@@ -5,13 +5,14 @@ import Foundation
 
 public struct Client {
 
-    public let models: ModelProvider
-    public let completions: CompletionProvider
+    public let audio: AudioProvider
     public let chats: ChatProvider
+    public let completions: CompletionProvider
     public let edits: EditProvider
-    public let images: ImageProvider
     public let embeddings: EmbeddingProvider
     public let files: FileProvider
+    public let images: ImageProvider
+    public let models: ModelProvider
     public let moderations: ModerationProvider
 
     public init(
@@ -23,7 +24,8 @@ public struct Client {
             httpClient: httpClient,
             configuration: configuration
         )
-                
+        
+        self.audio = AudioProvider(requestHandler: requestHandler)
         self.models = ModelProvider(requestHandler: requestHandler)
         self.completions = CompletionProvider(requestHandler: requestHandler)
         self.chats = ChatProvider(requestHandler: requestHandler)

Sources/OpenAIKit/File/FileProvider.swift

@@ -38,7 +38,7 @@ public struct FileProvider {
         purpose: File.Purpose
     ) async throws -> File {
 
-        let request = try UploadFileRequest(
+        let request = UploadFileRequest(
             file: file,
             fileName: fileName,
             purpose: purpose

Sources/OpenAIKit/File/Request/UploadFileRequest.swift

@@ -18,14 +18,14 @@ struct UploadFileRequest: Request {
         file: Data,
         fileName: String,
         purpose: File.Purpose
-    ) throws {
+    ) {
         let builder = MultipartFormDataBuilder(boundary: boundary)
 
         builder.addDataField(
             fieldName:  "file",
             fileName: fileName,
             data: file,
-            mimeType: "application/json"
+            mimeType: MIMEType.File.json.rawValue
         )
 
         builder.addTextField(named: "purpose", value: purpose.rawValue)