Add Service Lifetime to cache registration (#118)

marcominerva · Sep 19, 2023 · b3cd8e5 · b3cd8e5
2 parents fdda099 + fc42efb
commit b3cd8e5
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 15 deletions.
diff --git a/docs/ChatGptNet/IChatGptBuilderExtensions.md b/docs/ChatGptNet/IChatGptBuilderExtensions.md
@@ -10,7 +10,7 @@ public static class IChatGptBuilderExtensions
 
 | name | description |
 | --- | --- |
-| static [WithCache&lt;TImplementation&gt;](IChatGptBuilderExtensions/WithCache.md)(…) | Uses a custom cache implementation for conversation handling. |
+| static [WithCache&lt;TImplementation&gt;](IChatGptBuilderExtensions/WithCache.md)(…) | Defines a custom cache implementation for conversation handling. |
 
 ## See Also
 

diff --git a/docs/ChatGptNet/IChatGptBuilderExtensions/WithCache.md b/docs/ChatGptNet/IChatGptBuilderExtensions/WithCache.md
@@ -1,25 +1,23 @@
 # IChatGptBuilderExtensions.WithCache&lt;TImplementation&gt; method
 
-Uses a custom cache implementation for conversation handling.
+Defines a custom cache implementation for conversation handling.
 
 ```csharp
-public static IChatGptBuilder WithCache<TImplementation>(this IChatGptBuilder builder)
+public static IChatGptBuilder WithCache<TImplementation>(this IChatGptBuilder builder, 
+    ServiceLifetime lifetime = ServiceLifetime.Singleton)
     where TImplementation : class, IChatGptCache
 ```
 
 | parameter | description |
 | --- | --- |
 | TImplementation | The implementation of [`IChatGptCache`](../IChatGptCache.md) to use. |
 | builder | The [`IChatGptBuilder`](../IChatGptBuilder.md) object to configure. |
+| lifetime | The ServiceLifetime of the service. |
 
 ## Return Value
 
 The [`IChatGptBuilder`](../IChatGptBuilder.md) to further customize ChatGPT.
 
-## Remarks
-
-*TImplementation* is registered as singleton.
-
 ## See Also
 
 * interface [IChatGptBuilder](../IChatGptBuilder.md)

diff --git a/src/ChatGptNet/ChatGptServiceCollectionExtensions.cs b/src/ChatGptNet/ChatGptServiceCollectionExtensions.cs
@@ -18,7 +18,7 @@ public static class ChatGptServiceCollectionExtensions
     /// <param name="builder">The <see cref="ChatGptOptionsBuilder"/> to configure options.</param>
     /// <returns>A <see cref="IChatGptBuilder"/> that can be used to further customize ChatGPT.</returns>
     /// <remarks>This method automatically adds a <see cref="MemoryCache"/> that is used to save conversation history for chat completion.
-    /// It is possibile to use <see cref="IChatGptBuilderExtensions.WithCache{TImplementation}(IChatGptBuilder)"/> to specify another cache implementation.
+    /// It is possibile to use <see cref="IChatGptBuilderExtensions.WithCache{TImplementation}(IChatGptBuilder, ServiceLifetime)"/> to specify another cache implementation.
     /// </remarks>
     /// <seealso cref="ChatGptOptionsBuilder"/>
     /// <seealso cref="MemoryCacheServiceCollectionExtensions.AddMemoryCache(IServiceCollection)"/>
@@ -47,7 +47,7 @@ public static IChatGptBuilder AddChatGpt(this IServiceCollection services, Actio
     /// <param name="sectionName">The name of the configuration section that holds ChatGPT settings (default: ChatGPT).</param>
     /// <returns>A <see cref="IChatGptBuilder"/> that can be used to further customize ChatGPT.</returns>
     /// <remarks>This method automatically adds a <see cref="MemoryCache"/> that is used to save conversation history for chat completion.
-    /// It is possibile to use <see cref="IChatGptBuilderExtensions.WithCache{TImplementation}(IChatGptBuilder)"/> to specify another cache implementation.
+    /// It is possibile to use <see cref="IChatGptBuilderExtensions.WithCache{TImplementation}(IChatGptBuilder, ServiceLifetime)"/> to specify another cache implementation.
     /// </remarks>
     /// <seealso cref="ChatGptOptions"/>
     /// <seealso cref="IConfiguration"/>
@@ -75,7 +75,7 @@ public static IChatGptBuilder AddChatGpt(this IServiceCollection services, IConf
     /// <returns>A <see cref="IChatGptBuilder"/> that can be used to further customize ChatGPT.</returns>
     /// <remarks>Use this this method if it is necessary to dynamically set options (for example, using other services via dependency injection).
     /// This method automatically adds a <see cref="MemoryCache"/> that is used to save conversation history for chat completion.
-    /// It is possibile to use <see cref="IChatGptBuilderExtensions.WithCache{TImplementation}(IChatGptBuilder)"/> to specify another cache implementation.
+    /// It is possibile to use <see cref="IChatGptBuilderExtensions.WithCache{TImplementation}(IChatGptBuilder, ServiceLifetime)"/> to specify another cache implementation.
     /// </remarks>
     /// <seealso cref="ChatGptOptions"/>
     /// <seealso cref="IServiceProvider"/>

diff --git a/src/ChatGptNet/IChatGptBuilderExtensions.cs b/src/ChatGptNet/IChatGptBuilderExtensions.cs
@@ -9,20 +9,20 @@ namespace ChatGptNet;
 public static class IChatGptBuilderExtensions
 {
     /// <summary>
-    /// Uses a custom cache implementation for conversation handling.
+    /// Defines a custom cache implementation for conversation handling.
     /// </summary>
     /// <typeparam name="TImplementation">The implementation of <see cref="IChatGptCache"/> to use.</typeparam>
     /// <param name="builder">The <see cref="IChatGptBuilder"/> object to configure.</param>
+    /// <param name="lifetime">The <see cref="ServiceLifetime"/> of the service.</param>
     /// <returns>The <see cref="IChatGptBuilder"/> to further customize ChatGPT.</returns>
-    /// <remarks><typeparamref name="TImplementation"/> is registered as singleton.</remarks>
     /// <seealso cref="IChatGptBuilder"/>
     /// <seealso cref="IChatGptCache"/>
-    public static IChatGptBuilder WithCache<TImplementation>(this IChatGptBuilder builder)
+    public static IChatGptBuilder WithCache<TImplementation>(this IChatGptBuilder builder, ServiceLifetime lifetime = ServiceLifetime.Singleton)
         where TImplementation : class, IChatGptCache
     {
         ArgumentNullException.ThrowIfNull(builder);
 
-        builder.Services.Replace(ServiceDescriptor.Singleton<IChatGptCache, TImplementation>());
+        builder.Services.Replace(new ServiceDescriptor(typeof(IChatGptCache), typeof(TImplementation), lifetime));
 
         return builder;
     }

diff --git a/src/ChatGptNet/version.json b/src/ChatGptNet/version.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "2.4",
+  "version": "2.5",
   "publicReleaseRefSpec": [
     "^refs/heads/master$" // we release out of master
   ],