From b9127358490e9a29e899d7e71b691855405acae1 Mon Sep 17 00:00:00 2001
From: Jicheng Lu <103353@smsassist.com>
Date: Thu, 17 Oct 2024 18:19:15 -0500
Subject: [PATCH] add comments

---
 .../BotSharp.Abstraction/Instructs/IInstructService.cs   | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/Infrastructure/BotSharp.Abstraction/Instructs/IInstructService.cs b/src/Infrastructure/BotSharp.Abstraction/Instructs/IInstructService.cs
index f1d17b93..7e59ecea 100644
--- a/src/Infrastructure/BotSharp.Abstraction/Instructs/IInstructService.cs
+++ b/src/Infrastructure/BotSharp.Abstraction/Instructs/IInstructService.cs
@@ -14,6 +14,13 @@ public interface IInstructService
     /// <returns></returns>
     Task<InstructResult> Execute(string agentId, RoleDialogModel message, string? templateName = null, string? instruction = null);
 
-    
+    /// <summary>
+    /// A generic way to execute completion by using specified instruction or template
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    /// <param name="instruction"></param>
+    /// <param name="agentId"></param>
+    /// <param name="options"></param>
+    /// <returns></returns>
     Task<T?> Instruct<T>(string instruction, string agentId, InstructOptions options) where T : class;
 }