Skip to content

Commit dce8146

Browse files
committed
add xml doc
1 parent 0dbecdf commit dce8146

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

src/Plugins/BotSharp.Plugin.SemanticKernel/SemanticKernelChatCompletionProvider.cs

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,25 @@
1313

1414
namespace BotSharp.Plugin.SemanticKernel
1515
{
16+
/// <summary>
17+
/// Use Semantic Kernel as chat completion provider
18+
/// </summary>
1619
public class SemanticKernelChatCompletionProvider : IChatCompletion
1720
{
1821
private IKernel _kernel;
1922
private IServiceProvider _services;
2023
private ITokenStatistics _tokenStatistics;
2124
private string? _model = null;
2225

26+
/// <inheritdoc/>
2327
public string Provider => "semantic-kernel";
2428

29+
/// <summary>
30+
/// Create a new instance of <see cref="SemanticKernelChatCompletionProvider"/>
31+
/// </summary>
32+
/// <param name="kernel"></param>
33+
/// <param name="services"></param>
34+
/// <param name="tokenStatistics"></param>
2535
public SemanticKernelChatCompletionProvider(IKernel kernel,
2636
IServiceProvider services,
2737
ITokenStatistics tokenStatistics)
@@ -30,7 +40,7 @@ public SemanticKernelChatCompletionProvider(IKernel kernel,
3040
this._services = services;
3141
this._tokenStatistics = tokenStatistics;
3242
}
33-
43+
/// <inheritdoc/>
3444
public RoleDialogModel GetChatCompletions(Agent agent, List<RoleDialogModel> conversations)
3545
{
3646
var hooks = _services.GetServices<IContentGeneratingHook>().ToList();
@@ -81,18 +91,18 @@ public RoleDialogModel GetChatCompletions(Agent agent, List<RoleDialogModel> con
8191

8292
return msg;
8393
}
84-
94+
/// <inheritdoc/>
8595
public Task<bool> GetChatCompletionsAsync(Agent agent, List<RoleDialogModel> conversations, Func<RoleDialogModel, Task> onMessageReceived, Func<RoleDialogModel, Task> onFunctionExecuting)
8696
{
8797
throw new NotImplementedException();
8898
}
89-
99+
/// <inheritdoc/>
90100
public Task<bool> GetChatCompletionsStreamingAsync(Agent agent, List<RoleDialogModel> conversations, Func<RoleDialogModel, Task> onMessageReceived)
91101
{
92102
throw new NotImplementedException();
93103
}
94104

95-
105+
/// <inheritdoc/>
96106
public void SetModelName(string model)
97107
{
98108
if (!string.IsNullOrWhiteSpace(model))

src/Plugins/BotSharp.Plugin.SemanticKernel/SemanticKernelTextCompletionProvider.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,15 @@ public class SemanticKernelTextCompletionProvider : Abstraction.MLTasks.ITextCom
2424
private readonly ITokenStatistics _tokenStatistics;
2525
private string? _model = null;
2626

27-
// <inheritdoc/>
27+
/// <inheritdoc/>
2828
public string Provider => "semantic-kernel";
2929

30+
/// <summary>
31+
/// Create a new instance of <see cref="SemanticKernelTextCompletionProvider"/>
32+
/// </summary>
33+
/// <param name="kernel"></param>
34+
/// <param name="services"></param>
35+
/// <param name="tokenStatistics"></param>
3036
public SemanticKernelTextCompletionProvider(IKernel kernel,
3137
IServiceProvider services,
3238
ITokenStatistics tokenStatistics)

0 commit comments

Comments
 (0)