Skip to content

A programming framework for agentic AI

add xml comments for ISaveState.cs

Griffin Bassmana4e585e69e83
diff --git a/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/ISaveState.cs b/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/ISaveState.cs
index 7476fecce..dafdfb5d6 100644
--- a/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/ISaveState.cs
+++ b/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/ISaveState.cs
@@ -5,9 +5,31 @@ using StateDict = System.Collections.Generic.IDictionary<string, object>;
namespace Microsoft.AutoGen.Contracts.Python;
+/// <summary>
+/// Defines a contract for saving and loading the state of an object.
+/// The state must be JSON serializable.
+/// </summary>
+/// <typeparam name="T">The type of the object implementing this interface.</typeparam>
public interface ISaveState<T>
-{
+{
+ /// <summary>
+ /// Saves the current state of the object.
+ /// </summary>
+ /// <returns>
+ /// A task representing the asynchronous operation, returning a dictionary
+ /// containing the saved state. The structure of the state is implementation-defined
+ /// but must be JSON serializable.
+ /// </returns>
public ValueTask<StateDict> SaveStateAsync();
+
+ /// <summary>
+ /// Loads a previously saved state into the object.
+ /// </summary>
+ /// <param name="state">
+ /// A dictionary representing the saved state. The structure of the state
+ /// is implementation-defined but must be JSON serializable.
+ /// </param>
+ /// <returns>A task representing the asynchronous operation.</returns>
public ValueTask LoadStateAsync(StateDict state);
}