Skip to content

A programming framework for agentic AI

add xml comments for KVStringParseHelper.cs

Griffin Bassmane2082875e2c1
diff --git a/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/KVStringParseHelper.cs b/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/KVStringParseHelper.cs
index 11e83f2ca..21b03c362 100644
--- a/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/KVStringParseHelper.cs
+++ b/dotnet/src/Microsoft.AutoGen/Contracts/PythonEquiv/KVStringParseHelper.cs
@@ -5,11 +5,40 @@ using System.Text.RegularExpressions;
namespace Microsoft.AutoGen.Contracts.Python;
+/// <summary>
+/// Provides helper methods for parsing key-value string representations.
+/// </summary>
public static class KVStringParseHelper
{
+ /// <summary>
+ /// The regular expression pattern used to match key-value pairs in the format "key/value".
+ /// </summary>
private const string KVPairPattern = @"^(?<key>\w+)/(?<value>\w+)$";
+
+ /// <summary>
+ /// The compiled regex used for extracting key-value pairs from a string.
+ /// </summary>
private static readonly Regex KVPairRegex = new Regex(KVPairPattern, RegexOptions.Compiled);
+ /// <summary>
+ /// Parses a string in the format "key/value" into a tuple containing the key and value.
+ /// </summary>
+ /// <param name="kvString">The input string containing a key-value pair.</param>
+ /// <param name="keyName">The expected name of the key component.</param>
+ /// <param name="valueName">The expected name of the value component.</param>
+ /// <returns>A tuple containing the extracted key and value.</returns>
+ /// <exception cref="FormatException">
+ /// Thrown if the input string does not match the expected "key/value" format.
+ /// </exception>
+ /// <example>
+ /// Example usage:
+ /// <code>
+ /// string input = "agent1/12345";
+ /// var result = input.ToKVPair("Type", "Key");
+ /// Console.WriteLine(result.Item1); // Outputs: agent1
+ /// Console.WriteLine(result.Item2); // Outputs: 12345
+ /// </code>
+ /// </example>
public static (string, string) ToKVPair(this string kvString, string keyName, string valueName)
{
var match = KVPairRegex.Match(kvString);