Skip to content

Commit b1525f6

Browse files
committed
Add missing API docs
1 parent 6e049d9 commit b1525f6

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

src/Extensions.Grok/GrokClient.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,17 @@
44

55
namespace Devlooped.Extensions.AI.Grok;
66

7+
/// <summary>Client for interacting with the Grok service.</summary>
8+
/// <param name="apiKey">The API key used for authentication.</param>
9+
/// <param name="options">The options used to configure the client.</param>
710
public class GrokClient(string apiKey, GrokClientOptions options)
811
{
912
static ConcurrentDictionary<(Uri, string), GrpcChannel> channels = [];
1013

14+
/// <summary>Initializes a new instance of the <see cref="GrokClient"/> class with default options.</summary>
1115
public GrokClient(string apiKey) : this(apiKey, new GrokClientOptions()) { }
1216

17+
/// <summary>Gets the API key used for authentication.</summary>
1318
public string ApiKey { get; } = apiKey;
1419

1520
/// <summary>Gets or sets the endpoint for the service.</summary>
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
using Microsoft.Extensions.AI;
1+
using System.ComponentModel;
2+
using Microsoft.Extensions.AI;
23

34
namespace Devlooped.Extensions.AI.Grok;
45

6+
/// <summary>Provides extension methods for <see cref="GrokClient"/>.</summary>
7+
[EditorBrowsable(EditorBrowsableState.Never)]
58
public static class GrokClientExtensions
69
{
10+
/// <summary>Creates a new <see cref="IChatClient"/> from the specified <see cref="GrokClient"/> using the given model as the default.</summary>
711
public static IChatClient AsIChatClient(this GrokClient client, string defaultModelId)
812
=> new GrokChatClient(client.Channel, client.Options, defaultModelId);
913
}

src/Extensions.Grok/GrokClientOptions.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace Devlooped.Extensions.AI.Grok;
44

5+
/// <summary>Options for configuring the <see cref="GrokClient"/>.</summary>
56
public class GrokClientOptions
67
{
78
/// <summary> Gets or sets the service endpoint. </summary>

0 commit comments

Comments
 (0)