add xml comments for AgentMetadata.cs

This commit is contained in:
Griffin Bassman
2025-01-27 11:30:57 -05:00
committed by Jack Gerrits
parent c6c0351278
commit 74ad10f341

View File

@@ -3,10 +3,26 @@
namespace Microsoft.AutoGen.Contracts.Python;
/// <summary>
/// Represents metadata associated with an agent, including its type, unique key, and description.
/// </summary>
public struct AgentMetadata(string type, string key, string description)
{
/// <summary>
/// An identifier that associates an agent with a specific factory function.
/// Strings may only be composed of alphanumeric letters (a-z, 0-9), or underscores (_).
/// </summary>
public string Type { get; set; } = type;
/// <summary>
/// A unique key identifying the agent instance.
/// Strings may only be composed of alphanumeric letters (a-z, 0-9), or underscores (_).
/// </summary>
public string Key { get; set; } = key;
/// <summary>
/// A brief description of the agent's purpose or functionality.
/// </summary>
public string Description { get; set; } = description;
}