Add Fody.ConfigureAwait to modules; Fix Disposable pattern in OpenAiC…

…lient; Update to 2.7.1

Directory.Build.props

@@ -0,0 +1,6 @@
+<Project>
+    <PropertyGroup>
+        <Version>2.7.1</Version>
+        <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    </PropertyGroup>
+</Project>

OpenAI.ChatGpt.AspNetCore/OpenAI.ChatGpt.AspNetCore.csproj

@@ -8,7 +8,6 @@
         <PackageId>OpenAI.ChatGPT.AspNetCore</PackageId>
         <PackageProjectUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</PackageProjectUrl>
         <Product>OpenAI ChatGPT integration for .NET with DI</Product>
-        <Version>2.7.0</Version>
         <Description>OpenAI Chat Completions API (ChatGPT) integration with easy DI supporting (Microsoft.Extensions.DependencyInjection). It allows you to use the API in your .NET applications. Also, the client supports streaming responses (like ChatGPT) via async streams.</Description>
         <RepositoryUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</RepositoryUrl>
         <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
@@ -24,6 +23,8 @@
     </ItemGroup>
 
     <ItemGroup>
+        <ProjectReference Include="..\OpenAI.ChatGpt.Modules.StructuredResponse\OpenAI.ChatGpt.Modules.StructuredResponse.csproj" />
+        <ProjectReference Include="..\OpenAI.ChatGpt.Modules.Translator\OpenAI.ChatGpt.Modules.Translator.csproj" />
         <ProjectReference Include="..\OpenAI.ChatGpt\OpenAI.ChatGpt.csproj"/>
     </ItemGroup>
 

OpenAI.ChatGpt.EntityFrameworkCore/OpenAI.ChatGpt.EntityFrameworkCore.csproj

@@ -9,7 +9,6 @@
         <PackageId>OpenAI.ChatGPT.EntityFrameworkCore</PackageId>
         <PackageProjectUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</PackageProjectUrl>
         <Product>OpenAI ChatGPT integration for .NET with EF Core storage</Product>
-        <Version>2.7.0</Version>
         <Description>OpenAI Chat Completions API (ChatGPT) integration with DI and EF Core supporting. It allows you to use the API in your .NET applications. Also, the client supports streaming responses (like ChatGPT) via async streams.</Description>
         <RepositoryUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</RepositoryUrl>
         <TargetFrameworks>net6.0;net7.0</TargetFrameworks>

OpenAI.ChatGpt.Modules.StructuredResponse/FodyWeavers.xml

@@ -0,0 +1,3 @@
+<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
+  <ConfigureAwait />
+</Weavers>

OpenAI.ChatGpt.Modules.StructuredResponse/OpenAI.ChatGpt.Modules.StructuredResponse.csproj

@@ -8,7 +8,6 @@
         <PackageId>OpenAI.ChatGPT.Modules.StructuredResponse</PackageId>
         <PackageProjectUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</PackageProjectUrl>
         <Product>OpenAI ChatGPT structured response module</Product>
-        <Version>2.7.0</Version>
         <Description>The module for OpenAI ChatGPT that allows to retrive a structured response from ChatGPT.</Description>
         <RepositoryUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</RepositoryUrl>
         <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
@@ -25,6 +24,13 @@
     </PropertyGroup>
 
     <ItemGroup>
+        <PackageReference Include="ConfigureAwait.Fody" Version="3.3.2">
+            <PrivateAssets>all</PrivateAssets>
+        </PackageReference>
+        <PackageReference Include="Fody" Version="6.6.4">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
       <PackageReference Include="JsonSchema.Net.Generation" Version="3.3.0" />
     </ItemGroup>
 

OpenAI.ChatGpt.Modules.StructuredResponse/OpenAiClientExtensions.GetAsObjectAsync.cs → OpenAI.ChatGpt.Modules.StructuredResponse/OpenAiClientExtensions.GetStructuredResponse.cs

@@ -7,6 +7,7 @@
 
 namespace OpenAI.ChatGpt.Modules.StructuredResponse;
 
+[Fody.ConfigureAwait(false)]
 public static class OpenAiClientExtensions
 {
     /// <summary>
@@ -98,6 +99,11 @@ internal static async Task<TObject> GetStructuredResponse<TObject>(
                 rawResponseGetter,
                 cancellationToken);
 
+            response = response.Trim();
+            if(response.StartsWith("```") && response.EndsWith("```"))
+            {
+                response = response[3..^3];
+            }
             jsonDeserializerOptions ??= new JsonSerializerOptions
             {
                 PropertyNameCaseInsensitive = true,
@@ -120,7 +126,8 @@ internal static async Task<TObject> GetStructuredResponse<TObject>(
 
     private static string GetAdditionalJsonResponsePrompt(string responseFormat)
     {
-        return$"\n\nWrite your response in JSON format. The response structure is enclosed within double backticks (JSON Schema) ``{responseFormat}``";
+        return$"\n\nWrite your response in compact JSON format with escaped strings. " +
+              $"Here is the response structure, it is enclosed within double backticks (JSON Schema) ``{responseFormat}``";
     }
 
     internal static string CreateResponseFormatJson<TObject>()

OpenAI.ChatGpt.Modules.Translator/ChatGPTTranslatorService.cs

@@ -1,7 +1,13 @@
-using OpenAI.ChatGpt.Models.ChatCompletion;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using OpenAI.ChatGpt.Models.ChatCompletion;
+using OpenAI.ChatGpt.Models.ChatCompletion.Messaging;
+using OpenAI.ChatGpt.Modules.StructuredResponse;
 
 namespace OpenAI.ChatGpt.Modules.Translator;
 
+[Fody.ConfigureAwait(false)]
+// ReSharper disable once InconsistentNaming
 public class ChatGPTTranslatorService : IDisposable
 {
     private readonly IOpenAiClient _client;
@@ -45,14 +51,19 @@ public void Dispose()
         }
     }
 
-    public async Task<string> Translate(
+    public async Task<string> TranslateText(
         string text,
         string? sourceLanguage = null,
         string? targetLanguage = null,
+        int? maxTokens = null,
+        string? model = null,
+        float temperature = ChatCompletionTemperatures.Default,
+        string? user = null,
         Action<ChatCompletionRequest>? requestModifier = null,
+        Action<ChatCompletionResponse>? rawResponseGetter = null,
         CancellationToken cancellationToken = default)
     {
-        if (text == null) throw new ArgumentNullException(nameof(text));
+        ArgumentNullException.ThrowIfNull(text);
         var sourceLanguageOrDefault = sourceLanguage ?? _defaultSourceLanguage;
         var targetLanguageOrDefault = targetLanguage ?? _defaultTargetLanguage;
         if (sourceLanguageOrDefault is null)
@@ -63,21 +74,84 @@ public async Task<string> Translate(
         {
             throw new ArgumentNullException(nameof(targetLanguage), "Target language is not specified");
         }
-        var prompt = GetPrompt(sourceLanguageOrDefault, targetLanguageOrDefault);
+
+        var prompt = CreateTextTranslationPrompt(sourceLanguageOrDefault, targetLanguageOrDefault);
+        var messages = Dialog.StartAsSystem(prompt).ThenUser(text).GetMessages().ToArray();
+        (model, maxTokens) = ChatCompletionMessage.FindOptimalModelAndMaxToken(messages, model, maxTokens);
         var response = await _client.GetChatCompletions(
-            Dialog.StartAsSystem(prompt).ThenUser(text),
-            user: null,
-            requestModifier: requestModifier,
-            cancellationToken: cancellationToken
-        );
+            messages,
+            maxTokens.Value,
+            model,
+            temperature,
+            user,
+            requestModifier,
+            rawResponseGetter,
+            cancellationToken); 
         return response;
+
+        string CreateTextTranslationPrompt(string sourceLanguage, string targetLanguage)
+        {
+            ArgumentNullException.ThrowIfNull(sourceLanguage);
+            ArgumentNullException.ThrowIfNull(targetLanguage);
+            return $"I want you to act as a translator from {sourceLanguage} to {targetLanguage}. " +
+                   "The user provides with a sentence and you translate it. " +
+                   "In the response write ONLY translated text." + 
+                   (_extraPrompt is not null ? "\n" + _extraPrompt : "");
+        }
     }
-
-    private string GetPrompt(string sourceLanguage, string targetLanguage)
+
+    public async Task<TObject> TranslateObject<TObject>(
+        TObject objectToTranslate,
+        string? sourceLanguage = null,
+        string? targetLanguage = null,
+        int? maxTokens = null,
+        string? model = null,
+        float temperature = ChatCompletionTemperatures.Default,
+        string? user = null,
+        Action<ChatCompletionRequest>? requestModifier = null,
+        Action<ChatCompletionResponse>? rawResponseGetter = null,
+        JsonSerializerOptions? jsonSerializerOptions = null,
+        JsonSerializerOptions? jsonDeserializerOptions = null,
+        CancellationToken cancellationToken = default) where TObject : class
     {
-        return $"I want you to act as a translator from {sourceLanguage} to {targetLanguage}. " +
-               "I will provide you with an English sentence and you will translate it into Russian. " +
-               "In the response write ONLY translated text."
-            + (_extraPrompt is not null ? "\n" + _extraPrompt : "");
+        ArgumentNullException.ThrowIfNull(objectToTranslate);
+        var sourceLanguageOrDefault = sourceLanguage ?? _defaultSourceLanguage;
+        var targetLanguageOrDefault = targetLanguage ?? _defaultTargetLanguage;
+        if (sourceLanguageOrDefault is null)
+        {
+            throw new ArgumentNullException(nameof(sourceLanguage), "Source language is not specified");
+        }
+        if (targetLanguageOrDefault is null)
+        {
+            throw new ArgumentNullException(nameof(targetLanguage), "Target language is not specified");
+        }
+
+        var prompt = CreateObjectTranslationPrompt(sourceLanguageOrDefault, targetLanguageOrDefault);
+        jsonSerializerOptions ??= new JsonSerializerOptions() {DefaultIgnoreCondition = JsonIgnoreCondition.Never};
+        var objectJson = JsonSerializer.Serialize(objectToTranslate, jsonSerializerOptions);
+        var dialog = Dialog.StartAsSystem(prompt).ThenUser(objectJson);
+        var messages = dialog.GetMessages().ToArray();
+        (model, maxTokens) = ChatCompletionMessage.FindOptimalModelAndMaxToken(messages, model, maxTokens);
+        var response = await _client.GetStructuredResponse<TObject>(
+            dialog,
+            maxTokens.Value,
+            model,
+            temperature,
+            user,
+            requestModifier,
+            rawResponseGetter,
+            jsonDeserializerOptions,
+            cancellationToken
+        );
+        return response;
+
+        string CreateObjectTranslationPrompt(string sourceLanguage, string targetLanguage)
+        {
+            ArgumentNullException.ThrowIfNull(sourceLanguage);
+            ArgumentNullException.ThrowIfNull(targetLanguage);
+            return $"I want you to act as a translator from {sourceLanguage} to {targetLanguage}. " +
+                   "The user provides you with an object in json. You translate only the text fields that need to be translated. " +
+                   (_extraPrompt is not null ? "\n" + _extraPrompt : "");
+        }
     }
 }

OpenAI.ChatGpt.Modules.Translator/FodyWeavers.xml

@@ -0,0 +1,3 @@
+<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
+  <ConfigureAwait />
+</Weavers>

OpenAI.ChatGpt.Modules.Translator/OpenAI.ChatGpt.Modules.Translator.csproj

@@ -9,7 +9,6 @@
         <PackageId>OpenAI.ChatGPT.Modules.Translator</PackageId>
         <PackageProjectUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</PackageProjectUrl>
         <Product>OpenAI ChatGPT based language translator</Product>
-        <Version>2.7.0</Version>
         <Description>OpenAI ChatGPT based language translator.</Description>
         <RepositoryUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</RepositoryUrl>
         <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
@@ -26,7 +25,18 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <ProjectReference Include="..\OpenAI.ChatGpt\OpenAI.ChatGpt.csproj" />
+        <PackageReference Include="ConfigureAwait.Fody" Version="3.3.2">
+            <PrivateAssets>all</PrivateAssets>
+        </PackageReference>
+        <PackageReference Include="Fody" Version="6.6.4">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+    </ItemGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\OpenAI.ChatGpt.Modules.StructuredResponse\OpenAI.ChatGpt.Modules.StructuredResponse.csproj"/>
+        <ProjectReference Include="..\OpenAI.ChatGpt\OpenAI.ChatGpt.csproj"/>
     </ItemGroup>
 
 </Project>

OpenAI.ChatGpt.Modules.Translator/OpenAiClientExtensions.cs

@@ -0,0 +1,79 @@
+using System.Text.Json;
+using OpenAI.ChatGpt.Models.ChatCompletion;
+
+namespace OpenAI.ChatGpt.Modules.Translator;
+
+[Fody.ConfigureAwait(false)]
+public static class OpenAiClientExtensions
+{
+    public static Task<string> TranslateText(
+        this IOpenAiClient client,
+        string text,
+        string sourceLanguage,
+        string targetLanguage,
+        string? extraPrompt = null,
+        int? maxTokens = null,
+        string? model = null,
+        float temperature = ChatCompletionTemperatures.Default,
+        string? user = null,
+        Action<ChatCompletionRequest>? requestModifier = null,
+        Action<ChatCompletionResponse>? rawResponseGetter = null,
+        CancellationToken cancellationToken = default)
+    {
+        ArgumentNullException.ThrowIfNull(client);
+        ArgumentNullException.ThrowIfNull(text);
+        ArgumentNullException.ThrowIfNull(sourceLanguage);
+        ArgumentNullException.ThrowIfNull(targetLanguage);
+
+        var translator = new ChatGPTTranslatorService(client, extraPrompt: extraPrompt);
+        return translator.TranslateText(
+            text,
+            sourceLanguage,
+            targetLanguage,
+            maxTokens,
+            model,
+            temperature,
+            user,
+            requestModifier,
+            rawResponseGetter,
+            cancellationToken);
+    }
+
+    public static Task<TObject> TranslateObject<TObject>(
+        this IOpenAiClient client,
+        TObject objectToTranslate,
+        string sourceLanguage,
+        string targetLanguage,
+        string? extraPrompt = null,
+        int? maxTokens = null,
+        string? model = null,
+        float temperature = ChatCompletionTemperatures.Default,
+        string? user = null,
+        Action<ChatCompletionRequest>? requestModifier = null,
+        Action<ChatCompletionResponse>? rawResponseGetter = null,
+        JsonSerializerOptions? jsonSerializerOptions = null,
+        JsonSerializerOptions? jsonDeserializerOptions = null,
+        CancellationToken cancellationToken = default) where TObject: class
+    {
+        ArgumentNullException.ThrowIfNull(client);
+        ArgumentNullException.ThrowIfNull(objectToTranslate);
+        ArgumentNullException.ThrowIfNull(sourceLanguage);
+        ArgumentNullException.ThrowIfNull(targetLanguage);
+
+        var translator = new ChatGPTTranslatorService(client, extraPrompt: extraPrompt);
+        return translator.TranslateObject(
+            objectToTranslate,
+            sourceLanguage,
+            targetLanguage,
+            maxTokens,
+            model,
+            temperature,
+            user,
+            requestModifier,
+            rawResponseGetter,
+            jsonSerializerOptions,
+            jsonDeserializerOptions,
+            cancellationToken
+        );
+    }
+}

OpenAI.ChatGpt/ChatService.cs

@@ -13,6 +13,7 @@ namespace OpenAI.ChatGpt;
 /// Used for communication between a user and the assistant (ChatGPT).
 /// </summary>
 /// <remarks>Not thread-safe. Use one instance per user.</remarks>
+[Fody.ConfigureAwait(false)]
 [SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Global")]
 public class ChatService : IDisposable, IAsyncDisposable
 {

OpenAI.ChatGpt/HttpClientExtensions.cs

@@ -28,6 +28,9 @@ internal static async IAsyncEnumerable<TResponse>
             [EnumeratorCancellation] CancellationToken cancellationToken = default)
         where TRequest : notnull
     {
+        ArgumentNullException.ThrowIfNull(httpClient);
+        ArgumentNullException.ThrowIfNull(requestUri);
+        ArgumentNullException.ThrowIfNull(request);
         var requestMessage = new HttpRequestMessage(HttpMethod.Post, requestUri)
         {
             Content = JsonContent.Create(request, options: serializerOptions)

OpenAI.ChatGpt/OpenAI.ChatGpt.csproj

@@ -10,7 +10,6 @@
         <PackageId>OpenAI.ChatGPT</PackageId>
         <PackageProjectUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</PackageProjectUrl>
         <Product>OpenAI ChatGPT integration for .NET</Product>
-        <Version>2.7.0</Version>
         <Description>.NET integration for ChatGPT with streaming responses supporting (like ChatGPT) via async streams.</Description>
         <RepositoryUrl>https://github.com/rodion-m/ChatGPT_API_dotnet</RepositoryUrl>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>