Adding Azure and AIProxy support

Author: jamesrochabrun

PolyAIExample/PolyAIExample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -44,7 +44,7 @@ struct ApiKeyIntroView: View {
                   HStack {
                      TextField("Enter OpenAI API Key", text: $openAIAPIKey)
                      Button {
-                        configurations.append(.openAI(apiKey: openAIAPIKey))
+                        configurations.append(.openAI(.api(key: openAIAPIKey)))
                         openAIConfigAdded = true
                      } label: {
                         Image(systemName: "plus")

PolyAIExample/PolyAIExample/ApiKeysIntroView.swift

@@ -18,6 +18,8 @@ An open-source Swift package that simplifies LLM message completions, inspired b
 - [Usage](#usage)
 - [Message](#message)
 - [Collaboration](#collaboration)
+- [OpenAI Azure](OpenAI Azure)
+- [OpenAI AIProxy](AIProxy)
 
 ## Description
 
@@ -55,7 +57,7 @@ import PolyAI
 Then, define the LLM configurations. Currently, OpenAI and Anthropic are supported:
 
 ```swift
-let openAIConfiguration: LLMConfiguration = .openAI(apiKey: "your_openai_api_key_here")
+let openAIConfiguration: LLMConfiguration = .openAI(.api(key: "your_openai_api_key_here"))
 let anthropicConfiguration: LLMConfiguration = .anthropic(apiKey: "your_anthropic_api_key_here")
 let configurations = [openAIConfiguration, anthropicConfiguration]
 ```
@@ -86,6 +88,26 @@ let parameters: LLMParameter = .anthropic(model: .claude3Sonnet, messages: [.ini
 let stream = try await service.streamMessage(parameters)
 ```
 
+## OpenAI Azure
+
+To access the OpenAI API via Azure, you can use the following configuration setup.
+
+```swift
+let azureConfiguration: LLMConfiguration = .openAI(.azure(configuration: .init(resourceName: "YOUR_RESOURCE_NAME", openAIAPIKey: .apiKey("YOUR_API_KEY"), apiVersion: "THE_API_VERSION")))
+```
+
+More information can be found [here](https://github.com/jamesrochabrun/SwiftOpenAI?tab=readme-ov-file#azure-openai).
+
+## OpenAI AIProxy
+
+To access the OpenAI API via AIProxy, use the following configuration setup.
+
+```swift
+let aiProxyConfiguration: LLMConfiguration = .openAI(.aiProxy(aiproxyPartialKey: "hardcode_partial_key_here", aiproxyDeviceCheckBypass: "hardcode_device_check_bypass_here"))
+```
+
+More information can be found [here](https://github.com/jamesrochabrun/SwiftOpenAI?tab=readme-ov-file#aiproxy).
+
 ## Collaboration
 
 Open a PR for any proposed change pointing it to `main` branch.

README.md

@@ -22,8 +22,18 @@ struct DefaultPolyAIService: PolyAIService {
    {
       for configuration in configurations {
          switch configuration {
-         case .openAI(let apiKey, let organizationID, let configuration, let decoder):
-            openAIService = OpenAIServiceFactory.service(apiKey: apiKey, organizationID: organizationID, configuration: configuration, decoder: decoder)
+         case .openAI(let configuration):
+            switch configuration {
+            case .api(let key, let organizationID, let configuration, let decoder):
+               openAIService = OpenAIServiceFactory.service(apiKey: key, organizationID: organizationID, configuration: configuration, decoder: decoder)
+           
+            case .azure(let azureConfiguration, let urlSessionConfiguration, let decoder):
+               openAIService = OpenAIServiceFactory.service(azureConfiguration: azureConfiguration, urlSessionConfiguration: urlSessionConfiguration, decoder: decoder)
+          
+            case .aiProxy(let aiproxyPartialKey, let aiproxyDeviceCheckBypass, let configuration, let decoder):
+               openAIService = OpenAIServiceFactory.service(aiproxyPartialKey: aiproxyPartialKey, aiproxyDeviceCheckBypass: aiproxyDeviceCheckBypass, configuration: configuration, decoder: decoder)
+            }
+            
          case .anthropic(let apiKey, let configuration):
             anthropicService = AnthropicServiceFactory.service(apiKey: apiKey, configuration: configuration)
          }

Sources/PolyAI/Service/DefaultPolyAIService.swift

@@ -6,17 +6,35 @@
 //
 
 import Foundation
+import SwiftOpenAI
 
 /// Represents configurations for different LLM providers.
 public enum LLMConfiguration {
+
+   case openAI(OpenAI)
 
-   /// Configuration for accessing OpenAI's API.
-   /// - Parameters:
-   ///   - apiKey: The API key for authenticating requests to OpenAI.
-   ///   - organizationID: Optional organization ID for OpenAI usage.
-   ///   - configuration: The URLSession configuration to use for network requests. Defaults to `.default`.
-   ///   - decoder: The JSON decoder used for decoding responses. Defaults to a new instance of `JSONDecoder`.
-   case openAI(apiKey: String, organizationID: String? = nil, configuration: URLSessionConfiguration = .default, decoder: JSONDecoder = .init())
+   public enum OpenAI {
+      /// Configuration for accessing OpenAI's API.
+      /// - Parameters:
+      ///   - apiKey: The API key for authenticating requests to OpenAI.
+      ///   - organizationID: Optional organization ID for OpenAI usage.
+      ///   - configuration: The URLSession configuration to use for network requests. Defaults to `.default`.
+      ///   - decoder: The JSON decoder used for decoding responses. Defaults to a new instance of `JSONDecoder`.
+      case api(key: String, organizationID: String? = nil, configuration: URLSessionConfiguration = .default, decoder: JSONDecoder = .init())
+      /// Configuration for accessing OpenAI's API.
+      /// - Parameters:
+      ///   - configuration: The AzureOpenAIConfiguration.
+      ///   - urlSessionConfiguration: The URLSession configuration to use for network requests. Defaults to `.default`.
+      ///   - decoder: The JSON decoder used for decoding responses. Defaults to a new instance of `JSONDecoder`.
+      case azure(configuration: AzureOpenAIConfiguration, urlSessionConfiguration: URLSessionConfiguration = .default, decoder: JSONDecoder = .init())
+      /// Configuration for accessing OpenAI's API.
+      /// - Parameters:
+      ///   - aiproxyPartialKey: The partial key provided in the 'API Keys' section of the AIProxy dashboard.
+      ///   - aiproxyDeviceCheckBypass: The bypass token that is provided in the 'API Keys' section of the AIProxy dashboard.
+      ///   - configuration: The URLSession configuration to use for network requests. Defaults to `.default`.
+      ///   - decoder: The JSON decoder used for decoding responses. Defaults to a new instance of `JSONDecoder`.
+      case aiProxy(aiproxyPartialKey: String, aiproxyDeviceCheckBypass: String? = nil, configuration: URLSessionConfiguration = .default, decoder: JSONDecoder = .init())
+   }
 
    /// Configuration for accessing Anthropic's API.
    /// - Parameters: