From 88d0dd906a0a5f45fcd1ad426265bb90a967c498 Mon Sep 17 00:00:00 2001 From: Tolga Kayhan Date: Thu, 31 Oct 2024 19:50:35 +0000 Subject: [PATCH] readme update --- OpenAI.Playground/OpenAI.Playground.csproj | 8 ++++---- .../OpenAI.UtilitiesPlayground.csproj | 5 ----- OpenAI.sln | 2 -- Readme.md | 20 +++++++++++++++++++ 4 files changed, 24 insertions(+), 11 deletions(-) diff --git a/OpenAI.Playground/OpenAI.Playground.csproj b/OpenAI.Playground/OpenAI.Playground.csproj index d9e3cd49..cdcd7b33 100644 --- a/OpenAI.Playground/OpenAI.Playground.csproj +++ b/OpenAI.Playground/OpenAI.Playground.csproj @@ -22,13 +22,13 @@ - + - - + + @@ -48,7 +48,7 @@ - + diff --git a/OpenAI.UtilitiesPlayground/OpenAI.UtilitiesPlayground.csproj b/OpenAI.UtilitiesPlayground/OpenAI.UtilitiesPlayground.csproj index a951f951..9d21e5ac 100644 --- a/OpenAI.UtilitiesPlayground/OpenAI.UtilitiesPlayground.csproj +++ b/OpenAI.UtilitiesPlayground/OpenAI.UtilitiesPlayground.csproj @@ -9,10 +9,6 @@ latest - - - - @@ -25,7 +21,6 @@ - diff --git a/OpenAI.sln b/OpenAI.sln index bbab0393..1aa47654 100644 --- a/OpenAI.sln +++ b/OpenAI.sln @@ -5,8 +5,6 @@ VisualStudioVersion = 17.0.31912.275 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Betalgo.Ranul.OpenAI", "OpenAI.SDK\Betalgo.Ranul.OpenAI.csproj", "{780F7F1F-45FC-4832-9E00-5BE6F32E7271}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SDK", "SDK", "{B614DB37-E04E-454F-8C99-EF69BC503745}" -EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Playground", "Playground", "{ADCA5A92-4E8E-4574-8E5F-DDE4C03A4F49}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Test", "Test", "{C0FFCEC4-22E9-423B-B10B-DAF24446FA49}" diff --git a/Readme.md b/Readme.md index d7a2039e..10c5f6d5 100644 --- a/Readme.md +++ b/Readme.md @@ -115,6 +115,26 @@ Due to time constraints, not all methods have been thoroughly tested or fully do Needless to say, I cannot accept responsibility for any damage caused by using the library. ## Changelog +### 8.8.0 + +- **Compatibility Enhancement**: You can now use this library alongside the official OpenAI library and/or Semantic Kernel within the same project. The name changes in this update support this feature. + +- **Namespace and Package ID Update**: The namespace and PackageId have been changed from `Betalgo.OpenAI` to `Betalgo.Ranul.OpenAI`. + +- **OpenAI Naming Consistency**: We've standardized the use of "OpenAI" throughout the library, replacing any instances of "OpenAi" or other variations. + +- **Migration Instructions**: Intellisense should assist you in updating your code. If it doesn't, please make the following changes manually: + - Switch to the new NuGet package: `Betalgo.Ranul.OpenAI` instead of `Betalgo.OpenAI`. + - Update all namespaces from `OpenAI` to `Betalgo.Ranul.OpenAI`. + - Replace all occurrences of "OpenAi", "Openai", or any other variations with "OpenAI". + +- **Need Help?**: If you encounter any issues, feel free to reach out via our Discord channel, Reddit channel, or GitHub discussions. We're happy to assist. + +- **Feedback Welcomed**: If you notice any mistakes or missing name changes, please create an issue to let us know. + +- **Utilities Library Status**: Please note that the Utilities library might remain broken for a while. I will focus on fixing it after completing the real-time API implementation. + + ### 8.7.2 - Fixed incorrect Azure Urls. - Token usage response extended with `PromptTokensDetails`, `audio_tokens` and `cached_tokens`.