Merge pull request #2 from jamesrochabrun/jroch-adding-more-models-support

Updating Read.me

Author: jamesrochabrun

README.md

@@ -7,14 +7,39 @@
 [![swiftui-version](https://img.shields.io/badge/swiftui-brightgreen)](https://developer.apple.com/documentation/swiftui)
 [![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)
+[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://buymeacoffee.com/jamesrochabrun)
 
-An open-source Swift package that simplifies LLM message completions, inspired by [liteLLM](https://litellm.ai/) and adapted for Swift developers, following Swift conventions.
+An open-source Swift package that simplifies LLM message completions, designed for multi-model applications. It supports multiple providers while adhering to OpenAI-compatible APIs and Anthropic APIs, enabling Swift developers to integrate different AI models seamlessly.
 
 ## Description
 
-Call different LLM APIs using the OpenAI format; currently supporting [OpenAI](https://github.com/jamesrochabrun/SwiftOpenAI), [Anthropic](https://github.com/jamesrochabrun/SwiftAnthropic),  [Gemini](https://github.com/google-gemini/generative-ai-swift).
+### OpenAI Compatibility
 
-Also call any local model using [Ollama OpenAI compatibility endopints](https://ollama.com/blog/openai-compatibility). You can use models like [llama3](https://ollama.com/library/llama3) or [mistral](https://ollama.com/library/mistral).
+Easily call various LLM APIs using the OpenAI format, with built-in support for multiple models and providers through the [SwiftOpenAI](https://github.com/jamesrochabrun/SwiftOpenAI) package.
+
+Supported Providers:
+
+- OpenAI
+- Azure
+- Groq
+- DeepSeek
+- Google Gemini
+- OpenRouter
+- Ollama
+  - [llama3](https://ollama.com/library/llama3)
+  - [mistral](https://ollama.com/library/mistral)
+  
+Note: When using OpenAI-compatible configurations, you can identify them by the .openAI enum prefix in the configuration structure.
+
+Example:
+
+```swift
+.openAI(.gemini(apiKey: "your_gemini_api_key_here"))
+```
+
+### Anthropic
+
+Additionally, Anthropic API is supported through the [SwiftAnthropic](https://github.com/jamesrochabrun/SwiftAnthropic)
 
 ## Table of Contents
 
@@ -23,6 +48,9 @@ Also call any local model using [Ollama OpenAI compatibility endopints](https://
 - [Message](#message)
 - [Collaboration](#collaboration)
 - [OpenAI Azure](#openAI-azure)
+- [Groq](#groq)
+- [OpenRouter](#open-router)
+- [DeepSeek](#deepseek)
 - [OpenAI AIProxy](#openai-aiproxy)
 - [Ollama](#ollama)
 
@@ -63,13 +91,31 @@ import PolyAI
 ```
 
 Then, define the LLM configurations. 
-Currently, OpenAI, Anthropic and Gemini are supported, you can also use Ollama or any provider that provides local models with OpenAI endpoint compatibilities to use local models such llama3 or Mistral.
+
+Currently, the package supports OpenAI, Azure, Anthropic, Gemini, Groq, DeepSeek, and OpenRouter. Additionally, you can use Ollama to run local models like Llama 3 or Mistral through OpenAI-compatible endpoints.
 
 ```swift
-let openAIConfiguration: LLMConfiguration = .openAI(.api(key: "your_openai_api_key_here"))
+
+// OpenAI
+let openAIConfiguration: LLMConfiguration = .openAI(.api(key: "your_openai_api_key_here")
+
+// Gemini
+let geminiConfiguration: LLMConfiguration = .openAI(.gemini(apiKey: "your_gemini_api_key_here"))
+
+// Groq
+let groqConfiguration: LLMConfiguration = .openAI(.groq(apiKey: "your_groq_api_key_here"))
+
+// Ollama
+let ollamaConfiguration: LLMConfiguration = .openAI(.ollama(url: "http://localhost:11434"))
+
+// OpenRouter
+let openRouterConfiguration: LLMConfiguration = .openAI(.openRouter(apiKey: "your_open-router_api_key_here"))
+
+// DeepSeek
+let deepSeekConfiguration: LLMConfiguration = .openAI(.deepSeek(apiKey: "your_deepseek_api_key_here"))
+
+// Anthropic
 let anthropicConfiguration: LLMConfiguration = .anthropic(apiKey: "your_anthropic_api_key_here")
-let geminiConfiguration: LLMConfiguration = .gemini(apiKey: "your_gemini_api_key_here")
-let ollamaConfiguration: LLMConfiguration = .ollama(url: "http://localhost:11434")
 
 let configurations = [openAIConfiguration, anthropicConfiguration, geminiConfiguration, ollamaConfiguration]
 ```
@@ -80,18 +126,17 @@ With the configurations set, initialize the service:
 let service = PolyAIServiceFactory.serviceWith(configurations)
 ```
 
-Now, you have access to OpenAI, Anthropic, Gemini, llama3, Mistral models in a single package. 🚀
+Now, you have access to all the models offered by these providers in a single package. 🚀
 
 ## 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 parameters: LLMParameter = .openAI(model: .o1Preview, messages: [.init(role: .user, content: prompt)])
 let stream = try await service.streamMessage(parameters)
 ```
-
 To interact with Anthropic instead, all you need to do is change just one line of code! 🔥
 
 ```swift
@@ -116,6 +161,8 @@ let parameters: LLMParameter = .ollama(model: "llama3", messages: [.init(role: .
 let stream = try await service.streamMessage(parameters)
 ```
 
+As demonstrated, simply switch the LLMParameter to the desired provider.
+
 ## OpenAI Azure
 
 To access the OpenAI API via Azure, you can use the following configuration setup.
@@ -126,6 +173,33 @@ let azureConfiguration: LLMConfiguration = .openAI(.azure(configuration: .init(r
 
 More information can be found [here](https://github.com/jamesrochabrun/SwiftOpenAI?tab=readme-ov-file#azure-openai).
 
+## Groq
+
+To access Groq, use the following configuration setup.
+
+```swift
+let groqConfiguration: LLMConfiguration = .openAI(.groq(apiKey: "your_groq_api_key_here"))
+```
+More information can be found [here](https://github.com/jamesrochabrun/SwiftOpenAI?tab=readme-ov-file#groq).
+
+## OpenRouter
+
+To access OpenRouter, use the following configuration setup.
+
+```swift
+let openRouterConfiguration: LLMConfiguration = .openAI(.openRouter(apiKey: "your_open-router_api_key_here"))
+```
+More information can be found [here](https://github.com/jamesrochabrun/SwiftOpenAI?tab=readme-ov-file#openrouter).
+
+## DeepSeek
+
+To access DeepSeek, use the following configuration setup.
+
+```swift
+let deepSeekConfiguration: LLMConfiguration = .openAI(.deepSeek(apiKey: "your_deepseek_api_key_here"))
+```
+More information can be found [here](https://github.com/jamesrochabrun/SwiftOpenAI?tab=readme-ov-file#deepseek).
+
 ## OpenAI AIProxy
 
 To access the OpenAI API via AIProxy, use the following configuration setup.