Adding README

Author: jamesrochabrun

PolyAIExample/PolyAIExample/ApiKeysIntroView.swift

@@ -58,7 +58,7 @@ struct ApiKeyIntroView: View {
             .buttonStyle(.bordered)
             .padding()
             .textFieldStyle(.roundedBorder)
-            NavigationLink(destination: OptionsListView(service: PolyAIServiceFactory.configurations(configurations))) {
+            NavigationLink(destination: OptionsListView(service: PolyAIServiceFactory.serviceWith(configurations))) {
                Text("Continue")
                   .padding()
                   .padding(.horizontal, 48)

README.md

@@ -8,6 +8,84 @@
 [![xcode-version](https://img.shields.io/badge/xcode-15%20-brightgreen)](https://developer.apple.com/xcode/)
 [![swift-package-manager](https://img.shields.io/badge/package%20manager-compatible-brightgreen.svg?logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iNjJweCIgaGVpZ2h0PSI0OXB4IiB2aWV3Qm94PSIwIDAgNjIgNDkiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayI+CiAgICA8IS0tIEdlbmVyYXRvcjogU2tldGNoIDYzLjEgKDkyNDUyKSAtIGh0dHBzOi8vc2tldGNoLmNvbSAtLT4KICAgIDx0aXRsZT5Hcm91cDwvdGl0bGU+CiAgICA8ZGVzYz5DcmVhdGVkIHdpdGggU2tldGNoLjwvZGVzYz4KICAgIDxnIGlkPSJQYWdlLTEiIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPgogICAgICAgIDxnIGlkPSJHcm91cCIgZmlsbC1ydWxlPSJub256ZXJvIj4KICAgICAgICAgICAgPHBvbHlnb24gaWQ9IlBhdGgiIGZpbGw9IiNEQkI1NTEiIHBvaW50cz0iNTEuMzEwMzQ0OCAwIDEwLjY4OTY1NTIgMCAwIDEzLjUxNzI0MTQgMCA0OSA2MiA0OSA2MiAxMy41MTcyNDE0Ij48L3BvbHlnb24+CiAgICAgICAgICAgIDxwb2x5Z29uIGlkPSJQYXRoIiBmaWxsPSIjRjdFM0FGIiBwb2ludHM9IjI3IDI1IDMxIDI1IDM1IDI1IDM3IDI1IDM3IDE0IDI1IDE0IDI1IDI1Ij48L3BvbHlnb24+CiAgICAgICAgICAgIDxwb2x5Z29uIGlkPSJQYXRoIiBmaWxsPSIjRUZDNzVFIiBwb2ludHM9IjEwLjY4OTY1NTIgMCAwIDE0IDYyIDE0IDUxLjMxMDM0NDggMCI+PC9wb2x5Z29uPgogICAgICAgICAgICA8cG9seWdvbiBpZD0iUmVjdGFuZ2xlIiBmaWxsPSIjRjdFM0FGIiBwb2ludHM9IjI3IDAgMzUgMCAzNyAxNCAyNSAxNCI+PC9wb2x5Z29uPgogICAgICAgIDwvZz4KICAgIDwvZz4KPC9zdmc+)](https://github.com/apple/swift-package-manager)
 
+
 An open-source Swift package that simplifies LLM message completions, inspired by [liteLLM](https://litellm.ai/) and adapted for Swift developers, following Swift conventions.
 
-Call different LLM APIs using the OpenAI format; currently supporting OpenAI and Anthropic, with more models, including Gemini, coming soon.
+## Table of Contents
+
+- [Description](#description)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Message](#message)
+- [Collaboration](#collaboration)
+
+## Description
+
+Call different LLM APIs using the OpenAI format; currently supporting [OpenAI](https://github.com/jamesrochabrun/SwiftOpenAI) and [Anthropic](https://github.com/jamesrochabrun/SwiftAnthropic), with more models, including Gemini, coming soon.
+
+## Installation
+
+### Swift Package Manager
+
+1. Open your Swift project in Xcode.
+2. Go to `File` ->  `Add Package Dependency`.
+3. In the search bar, enter [this URL](https://github.com/jamesrochabrun/PolyAI).
+4. Choose the version you'd like to install.
+5. Click `Add Package`.
+
+### Important
+
+⚠️  Please take precautions to keep your API keys secure.
+
+> Remember that your API keys are a secret! Do not share it with others or expose
+> it in any client-side code (browsers, apps). Production requests must be
+> routed through your backend server where your API keys can be securely
+> loaded from an environment variable or key management service.
+
+## Usage
+
+To interface with different LLMs, you need only to supply the corresponding LLM configuration and adjust the parameters accordingly.
+
+First, import the PolyAI package:
+
+```swift
+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 anthropicConfiguration: LLMConfiguration = .anthropic(apiKey: "your_anthropic_api_key_here")
+let configurations = [openAIConfiguration, anthropicConfiguration]
+```
+
+With the configurations set, initialize the service:
+
+```swift
+let service = PolyAIServiceFactory.serviceWith(configurations)
+```
+
+Now, you have access to both the OpenAI and Anthropic APIs in a single package, with Gemini coming soon! 🚀
+
+## Message
+
+To send a message using OpenAI:
+
+```swift
+let prompt = "How are you today?"
+let parameters: LLMParameter = .openAI(model: .gpt4turbo, messages: [.init(role: .user, content: prompt)])
+let stream = try await service.streamMessage(parameters)
+```
+
+To interact with Anthropic instead, all you need to do is update the parameters:
+
+```swift
+let prompt = "How are you today?"
+let parameters: LLMParameter = .anthropic(model: .claude3Sonnet, messages: [.init(role: .user, content: prompt)], maxTokens: 1024)
+let stream = try await service.streamMessage(parameters)
+```
+
+## Collaboration
+
+Open a PR for any proposed change pointing it to `main` branch.

Sources/PolyAI/Interfaces/Parameters/LLMMessageParameter.swift

@@ -9,6 +9,7 @@ import Foundation
 
 // MARK: LLMMessageParameter
 
+/// A protocol defining the basic requirements for a message parameter used with LLM services.
 public protocol LLMMessageParameter {
 
    var role: String { get }
@@ -19,14 +20,21 @@ public protocol LLMMessageParameter {
 
 public struct LLMMessage: LLMMessageParameter {
 
+   /// The role of the sender in the conversation, such as "user" or "assistant".
    public var role: String
+   
+   /// The content of the message being sent.
    public var content: String
 
    public enum Role: String {
       case user
       case assistant
    }
 
+   /// Initializes a new message with specified role and content.
+   /// - Parameters:
+   ///   - role: The role of the sender of the message.
+   ///   - content: The content of the message.
    public init(
       role: Role,
       content: String)

Sources/PolyAI/Interfaces/Parameters/LLMParameter.swift

@@ -9,11 +9,24 @@ import Foundation
 import SwiftOpenAI
 import SwiftAnthropic
 
+/// An enum representing the parameters required to interface with different LLM services.
 public enum LLMParameter {
 
+   /// Represents a configuration for interacting with OpenAI's models.
+     /// - Parameters:
+     ///   - model: The specific model of OpenAI to use.
+     ///   - messages: An array of messages to send to the model.
+     ///   - maxTokens: An optional maximum number of tokens to generate. Defaults to `nil`.
    case openAI(model: SwiftOpenAI.Model, messages: [LLMMessage], maxTokens: Int? = nil)
+   
+   /// Represents a configuration for interacting with Anthropic's models.
+   /// - Parameters:
+   ///   - model: The specific model of Anthropic to use.
+   ///   - messages: An array of messages to send to the model.
+   ///   - maxTokens: The maximum number of tokens to generate.
    case anthropic(model: SwiftAnthropic.Model, messages: [LLMMessage], maxTokens: Int)
 
+   /// A computed property that returns the name of the LLM service based on the case.
    var llmService: String {
       switch self {
       case .openAI: return "OpenAI"

Sources/PolyAI/Interfaces/Response/LLMMessageResponse.swift

@@ -0,0 +1,37 @@
+//
+//  LLMMessageResponse+Anthropic.swift
+//
+//
+//  Created by James Rochabrun on 4/15/24.
+//
+
+import Foundation
+import SwiftAnthropic
+
+// MARK: Anthropic
+
+extension MessageResponse: LLMMessageResponse {
+   
+   public var createdAt: Int? {
+      nil
+   }
+   
+   public var contentDescription: String {
+      content.map { contentItem in
+         switch contentItem {
+         case .text(let text):
+            return text
+         case .toolUse(_, let name, _):
+            return "Tool: \(name)"
+         }
+      }.first ?? ""
+   }
+   
+   public var usageMetrics: UsageMetrics {
+      ChatUsageMetrics(inputTokens: usage.inputTokens, outputTokens: usage.outputTokens, totalTokens: nil)
+   }
+   
+   public var tools: [ToolUsage] {
+      []
+   }
+}

Sources/PolyAI/Interfaces/Response/LLMMessageStreamResponse.swift

@@ -0,0 +1,34 @@
+//
+//  LLMMessageResponse+OpenAI.swift
+//  
+//
+//  Created by James Rochabrun on 4/15/24.
+//
+
+import Foundation
+import SwiftOpenAI
+
+// MARK: OpenAI
+
+extension ChatCompletionObject: LLMMessageResponse {
+   
+   public var createdAt: Int? {
+      created
+   }
+   
+   public var contentDescription: String {
+      choices.first?.message.content ?? ""
+   }
+   
+   public var usageMetrics: UsageMetrics {
+      ChatUsageMetrics(inputTokens: usage.promptTokens, outputTokens: usage.completionTokens, totalTokens: usage.totalTokens)
+   }
+   
+   public var tools: [ToolUsage] {
+      []
+   }
+   
+   public var role: String {
+      choices.first?.message.role ?? "unknown"
+   }
+}