Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
kayhantolga committed Oct 31, 2024
1 parent a54b8bb commit 88d0dd9
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 11 deletions.
8 changes: 4 additions & 4 deletions OpenAI.Playground/OpenAI.Playground.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="LaserCatEyes.HttpClientListener" Version="8.0.0" />
<PackageReference Include="LaserCatEyes.HttpClientListener" Version="8.0.1" />
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
<PackageReference Include="Microsoft.Extensions.Configuration" Version="8.0.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="8.0.0" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="8.0.1" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.1" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="8.0.0" />
</ItemGroup>

Expand All @@ -48,7 +48,7 @@

<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="8.0.0" />
<PackageReference Include="System.Net.Http.Json" Version="8.0.0" />
<PackageReference Include="System.Net.Http.Json" Version="8.0.1" />
</ItemGroup>

<ItemGroup>
Expand Down
5 changes: 0 additions & 5 deletions OpenAI.UtilitiesPlayground/OpenAI.UtilitiesPlayground.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@
<LangVersion>latest</LangVersion>
</PropertyGroup>

<ItemGroup Condition="'$(TargetFramework)' != 'netstandard2.0'">
<PackageReference Include="LaserCatEyes.HttpClientListener" Version="6.0.0" />
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Configuration" Version="8.0.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.1" />
Expand All @@ -25,7 +21,6 @@
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\OpenAI.Utilities\Betalgo.OpenAI.Utilities.csproj" />
<ProjectReference Include="..\OpenAI.Utilities\OpenAI.Utilities.csproj" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 0 additions & 2 deletions OpenAI.sln
Original file line number Diff line number Diff line change
Expand Up @@ -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}"
Expand Down
20 changes: 20 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 88d0dd9

Please sign in to comment.