add support for OpenAI models (#35)

sebsto · Copilot · web-flow · commit bc5a47fb35c6 · 2025-08-08T16:34:42.000+02:00
* add support for OpenAI models

* [CI] add openai example to CI tests

* optimize regex

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;

* revert incorrect copilot suggestion

---------

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -35,7 +35,7 @@ jobs:
       # We pass the list of examples here, but we can't pass an array as argument
       # Instead, we pass a String with a valid JSON array.
       # The workaround is mentioned here https://github.com/orgs/community/discussions/11692
-      examples: "[ 'api-key', 'converse', 'converse-stream', 'text_chat' ]"
+      examples: "[ 'api-key', 'converse', 'converse-stream', 'openai', 'text_chat' ]"
 
   swift-6-language-mode:
     name: Swift 6 Language Mode
diff --git a/Examples/openai/.gitignore b/Examples/openai/.gitignore
@@ -0,0 +1,8 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc
diff --git a/Examples/openai/Package.swift b/Examples/openai/Package.swift
@@ -0,0 +1,36 @@
+// swift-tools-version: 6.1
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "OpenAI",
+    platforms: [.macOS(.v15), .iOS(.v18), .tvOS(.v18)],
+    dependencies: [
+        // for production use, uncomment the following line
+        // .package(url: "https://github.com/build-on-aws/swift-bedrock-library.git", branch: "main"),
+
+        // for local development, use the following line
+        .package(name: "swift-bedrock-library", path: "../.."),
+
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.5.0"),
+    ],
+    targets: [
+        .executableTarget(
+            name: "OpenAIInvoke",
+            dependencies: [
+                .product(name: "BedrockService", package: "swift-bedrock-library"),
+                .product(name: "Logging", package: "swift-log"),
+            ],
+            path: "Sources/Invoke"
+        ),
+        .executableTarget(
+            name: "OpenAIConverse",
+            dependencies: [
+                .product(name: "BedrockService", package: "swift-bedrock-library"),
+                .product(name: "Logging", package: "swift-log"),
+            ],
+            path: "Sources/Converse"
+        ),
+    ]
+)
diff --git a/Examples/openai/Sources/Converse/main.swift b/Examples/openai/Sources/Converse/main.swift
@@ -0,0 +1,32 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift Bedrock Library open source project
+//
+// Copyright (c) 2025 Amazon.com, Inc. or its affiliates
+//                    and the Swift Bedrock Library project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of Swift Bedrock Library project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import BedrockService
+import Logging
+
+var logger = Logger(label: "OpenAIConverse")
+logger.logLevel = .debug
+
+let bedrock = try await BedrockService(
+    region: .uswest2,
+    logger: logger,
+)
+
+var builder = try ConverseRequestBuilder(with: .openai_gpt_oss_20b)
+    .withPrompt("Who are you?")
+
+var reply = try await bedrock.converse(with: builder)
+
+print("Assistant: \(reply)")
diff --git a/Examples/openai/Sources/Invoke/main.swift b/Examples/openai/Sources/Invoke/main.swift
@@ -0,0 +1,35 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift Bedrock Library open source project
+//
+// Copyright (c) 2025 Amazon.com, Inc. or its affiliates
+//                    and the Swift Bedrock Library project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of Swift Bedrock Library project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import BedrockService
+import Logging
+
+var logger = Logger(label: "OpenAIInvoke")
+logger.logLevel = .debug
+
+let bedrock = try await BedrockService(
+    region: .uswest2,
+    logger: logger
+)
+
+let textCompletion = try await bedrock.completeText(
+    "Who are you?",
+    with: .openai_gpt_oss_20b
+)
+
+if let reasoning = textCompletion.reasoning {
+    print("------- Reasoning ----------\n\(reasoning)\n----------------------------\n")
+}
+print(textCompletion.completion)
diff --git a/Sources/BedrockModel.swift b/Sources/BedrockModel.swift
@@ -101,6 +101,9 @@ public struct BedrockModel: Hashable, Sendable, Equatable, RawRepresentable {
         //cohere
         case BedrockModel.cohere_command_R_plus.id: self = BedrockModel.cohere_command_R_plus
         case BedrockModel.cohere_command_R.id: self = BedrockModel.cohere_command_R
+        // OpenAI
+        case BedrockModel.openai_gpt_oss_20b.id: self = BedrockModel.openai_gpt_oss_20b
+        case BedrockModel.openai_gpt_oss_120b.id: self = BedrockModel.openai_gpt_oss_120b
         default:
             return nil
         }
diff --git a/Sources/Converse/ConverseReply.swift b/Sources/Converse/ConverseReply.swift
@@ -13,7 +13,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-public struct ConverseReply: Codable, CustomStringConvertible {
+public struct ConverseReply: Codable, Sendable, CustomStringConvertible {
     let history: History
     let textReply: String?
     let toolUse: ToolUseBlock?
diff --git a/Sources/InvokeModel/BedrockService+InvokeModelImage.swift b/Sources/InvokeModel/BedrockService+InvokeModelImage.swift
@@ -182,7 +182,8 @@ extension BedrockService {
         }
         let invokemodelResponse: InvokeModelResponse = try InvokeModelResponse.createImageResponse(
             body: responseBody,
-            model: model
+            model: model,
+            logger: self.logger
         )
         return try invokemodelResponse.getGeneratedImage()
     }
diff --git a/Sources/InvokeModel/BedrockService+InvokeModelText.swift b/Sources/InvokeModel/BedrockService+InvokeModelText.swift
@@ -119,7 +119,8 @@ extension BedrockService {
 
             let invokemodelResponse: InvokeModelResponse = try InvokeModelResponse.createTextResponse(
                 body: responseBody,
-                model: model
+                model: model,
+                logger: self.logger
             )
             logger.trace(
                 "Generated text completion",
diff --git a/Sources/InvokeModel/InvokeModelResponse.swift b/Sources/InvokeModel/InvokeModelResponse.swift
@@ -15,6 +15,7 @@
 
 @preconcurrency import AWSBedrockRuntime
 import Foundation
+import Logging
 
 public struct InvokeModelResponse {
     let model: BedrockModel
@@ -50,9 +51,10 @@ public struct InvokeModelResponse {
     ///   - model: The Bedrock model that generated the response
     /// - Throws: BedrockLibraryError.invalidModel if the model is not supported
     ///          BedrockLibraryError.invalidResponseBody if the response cannot be decoded
-    static func createTextResponse(body data: Data, model: BedrockModel) throws -> Self {
+    static func createTextResponse(body data: Data, model: BedrockModel, logger: Logger) throws -> Self {
         do {
             let textModality = try model.getTextModality()
+            logger.trace("Raw response data:\n\(String(data: data, encoding: .utf8) ?? "")\n")
             return self.init(model: model, textCompletionBody: try textModality.getTextResponseBody(from: data))
         } catch {
             throw BedrockLibraryError.invalidSDKResponseBody(data)
@@ -65,9 +67,10 @@ public struct InvokeModelResponse {
     ///   - model: The Bedrock model that generated the response
     /// - Throws: BedrockLibraryError.invalidModel if the model is not supported
     ///          BedrockLibraryError.invalidResponseBody if the response cannot be decoded
-    static func createImageResponse(body data: Data, model: BedrockModel) throws -> Self {
+    static func createImageResponse(body data: Data, model: BedrockModel, logger: Logger) throws -> Self {
         do {
             let imageModality = try model.getImageModality()
+            logger.trace("Raw response", metadata: ["Data": "\(String(data: data, encoding: .utf8) ?? "")"])
             return self.init(model: model, imageGenerationBody: try imageModality.getImageResponseBody(from: data))
         } catch {
             throw BedrockLibraryError.invalidSDKResponseBody(data)
diff --git a/Sources/InvokeModel/TextCompletion.swift b/Sources/InvokeModel/TextCompletion.swift
@@ -15,10 +15,26 @@
 
 import Foundation
 
-public struct TextCompletion: Codable {
+public struct TextCompletion: Codable, Sendable {
     public let completion: String
+    public let reasoning: String?
 
     public init(_ completion: String) {
-        self.completion = completion
+        let (extractedCompletion, extractedReasoning) = Self.extractReasoning(from: completion)
+        self.completion = extractedCompletion
+        self.reasoning = extractedReasoning
+    }
+
+    private static func extractReasoning(from text: String) -> (completion: String, reasoning: String?) {
+        let reasoningRegex = /<reasoning>(.*?)<\/reasoning>/
+
+        guard let match = text.firstMatch(of: reasoningRegex) else {
+            return (text, nil)
+        }
+
+        let reasoning = String(match.1)
+        let cleanedText = text.replacing(reasoningRegex, with: "")
+
+        return (cleanedText, reasoning)
     }
 }
diff --git a/Sources/Models/OpenAI/OpenAI.swift b/Sources/Models/OpenAI/OpenAI.swift
@@ -0,0 +1,74 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift Bedrock Library open source project
+//
+// Copyright (c) 2025 Amazon.com, Inc. or its affiliates
+//                    and the Swift Bedrock Library project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of Swift Bedrock Library project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+
+struct OpenAIText: TextModality, ConverseModality {
+    let parameters: TextGenerationParameters
+    let converseParameters: ConverseParameters
+    let converseFeatures: [ConverseFeature]
+    let maxReasoningTokens: Parameter<Int>
+
+    func getName() -> String { "OpenAI Text Generation" }
+
+    init(
+        parameters: TextGenerationParameters,
+        features: [ConverseFeature] = [.textGeneration, .systemPrompts, .document],
+        maxReasoningTokens: Parameter<Int> = .notSupported(.maxReasoningTokens)
+    ) {
+        self.parameters = parameters
+        self.converseFeatures = features
+        self.converseParameters = ConverseParameters(
+            textGenerationParameters: parameters,
+            maxReasoningTokens: maxReasoningTokens
+        )
+        self.maxReasoningTokens = maxReasoningTokens
+    }
+
+    func getParameters() -> TextGenerationParameters {
+        parameters
+    }
+
+    func getConverseParameters() -> ConverseParameters {
+        ConverseParameters(textGenerationParameters: parameters, maxReasoningTokens: maxReasoningTokens)
+    }
+
+    func getTextRequestBody(
+        prompt: String,
+        maxTokens: Int?,
+        temperature: Double?,
+        topP: Double?,
+        topK: Int?,
+        stopSequences: [String]?
+    ) throws -> BedrockBodyCodable {
+        guard let maxTokens = maxTokens ?? parameters.maxTokens.defaultValue else {
+            throw BedrockLibraryError.notFound("No value was given for maxTokens and no default value was found")
+        }
+        if topP != nil && temperature != nil {
+            throw BedrockLibraryError.notSupported("Alter either topP or temperature, but not both.")
+        }
+        return OpenAIRequestBody(
+            prompt: prompt,
+            maxTokens: maxTokens,
+            temperature: temperature ?? parameters.temperature.defaultValue,
+            topP: topP ?? parameters.topP.defaultValue,
+        )
+    }
+
+    func getTextResponseBody(from data: Data) throws -> ContainsTextCompletion {
+        let decoder = JSONDecoder()
+        return try decoder.decode(OpenAIResponseBody.self, from: data)
+    }
+}
diff --git a/Sources/Models/OpenAI/OpenAIBedrockModels.swift b/Sources/Models/OpenAI/OpenAIBedrockModels.swift
@@ -0,0 +1,51 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift Bedrock Library open source project
+//
+// Copyright (c) 2025 Amazon.com, Inc. or its affiliates
+//                    and the Swift Bedrock Library project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of Swift Bedrock Library project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+
+// https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters-openai.html
+
+extension BedrockModel {
+    public static let openai_gpt_oss_20b: BedrockModel = BedrockModel(
+        id: "openai.gpt-oss-20b-1:0",
+        name: "OpenAI GPT OSS 20b",
+        modality: OpenAIText(
+            parameters: TextGenerationParameters(
+                temperature: Parameter(.temperature, minValue: 0, maxValue: 1, defaultValue: 0.7),
+                maxTokens: Parameter(.maxTokens, minValue: 0, maxValue: 2_048, defaultValue: 150),
+                topP: Parameter(.topP, minValue: 0, maxValue: 1, defaultValue: 0.9),
+                topK: Parameter.notSupported(.topK),
+                stopSequences: StopSequenceParams.notSupported(),
+                maxPromptSize: nil
+            ),
+            features: [.textGeneration, .systemPrompts, .document]
+        )
+    )
+    public static let openai_gpt_oss_120b: BedrockModel = BedrockModel(
+        id: "openai.gpt-oss-120b-1:0",
+        name: "OpenAI GPT OSS 120b",
+        modality: OpenAIText(
+            parameters: TextGenerationParameters(
+                temperature: Parameter(.temperature, minValue: 0, maxValue: 1, defaultValue: 0.7),
+                maxTokens: Parameter(.maxTokens, minValue: 0, maxValue: 2_048, defaultValue: 150),
+                topP: Parameter(.topP, minValue: 0, maxValue: 1, defaultValue: 0.9),
+                topK: Parameter.notSupported(.topK),
+                stopSequences: StopSequenceParams.notSupported(),
+                maxPromptSize: nil
+            ),
+            features: [.textGeneration, .systemPrompts, .document]
+        )
+    )
+}
diff --git a/Sources/Models/OpenAI/OpenAIRequestBody.swift b/Sources/Models/OpenAI/OpenAIRequestBody.swift
@@ -0,0 +1,42 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift Bedrock Library open source project
+//
+// Copyright (c) 2025 Amazon.com, Inc. or its affiliates
+//                    and the Swift Bedrock Library project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of Swift Bedrock Library project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+
+public struct OpenAIRequestBody: BedrockBodyCodable {
+    private let max_completion_tokens: Int
+    private let temperature: Double?
+    private let top_p: Double?
+    private let messages: [OpenAIMessage]
+
+    public init(
+        prompt: String,
+        maxTokens: Int,
+        temperature: Double?,
+        topP: Double?
+    ) {
+        self.max_completion_tokens = maxTokens
+        self.temperature = temperature
+        self.messages = [
+            OpenAIMessage(role: .user, content: prompt)
+        ]
+        self.top_p = topP
+    }
+
+    private struct OpenAIMessage: Codable {
+        let role: Role
+        let content: String
+    }
+}
diff --git a/Sources/Models/OpenAI/OpenAIResponseBody.swift b/Sources/Models/OpenAI/OpenAIResponseBody.swift
diff --git a/Tests/InvokeModel/TextCompletionTests.swift b/Tests/InvokeModel/TextCompletionTests.swift

Original file line number	Diff line number	Diff line change
`@@ -182,7 +182,8 @@ extension BedrockService {`
`182`	`182`	`}`
`183`	`183`	`let invokemodelResponse: InvokeModelResponse = try InvokeModelResponse.createImageResponse(`
`184`	`184`	`body: responseBody,`
`185`		`- model: model`
	`185`	`+ model: model,`
	`186`	`+ logger: self.logger`
`186`	`187`	`)`
`187`	`188`	`return try invokemodelResponse.getGeneratedImage()`
`188`	`189`	`}`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,8 @@ extension BedrockService {`
`119`	`119`
`120`	`120`	`let invokemodelResponse: InvokeModelResponse = try InvokeModelResponse.createTextResponse(`
`121`	`121`	`body: responseBody,`
`122`		`- model: model`
	`122`	`+ model: model,`
	`123`	`+ logger: self.logger`
`123`	`124`	`)`
`124`	`125`	`logger.trace(`
`125`	`126`	`"Generated text completion",`