Skip to content

Commit 4bad084

Browse files
authored
docs: AI config --> AI Config name change (#83)
**Requirements** - [ ] I have added test coverage for new or changed functionality - [x] I have followed the repository's [pull request submission guidelines](../blob/main/CONTRIBUTING.md#submitting-pull-requests) - [ ] I have validated my changes against all supported platform versions **Related issues** https://launchdarkly.atlassian.net/browse/DOCS-2117 **Describe the solution you've provided** Style guide change requires an update in capitalization here.
1 parent 1c465a8 commit 4bad084

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

pkgs/sdk/server-ai/docs-src/namespaces/LaunchDarkly.Sdk.Server.Ai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ var baseClient = new LdClient(Configuration.Builder("sdk-key").Build());
1515
// The AI client wraps the base client, providing additional AI-related functionality.
1616
var aiClient = new LdAiClient(new LdClientAdapter(baseClient));
1717

18-
// Pass in the key of the AI config, a context, and a default value in case the config can't be
18+
// Pass in the key of the AI Config, a context, and a default value in case the config can't be
1919
// retrieved from LaunchDarkly.
2020
var myModelConfig = aiClient.Config("my-model-config", Context.New("user-key"), LdAiConfig.Disabled);
2121
```

pkgs/sdk/server-ai/src/Config/LdAiConfig.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
namespace LaunchDarkly.Sdk.Server.Ai.Config;
66

77
/// <summary>
8-
/// Represents an AI configuration, which contains model parameters and prompt messages.
8+
/// Represents an AI Config, which contains model parameters and prompt messages.
99
/// </summary>
1010
public record LdAiConfig
1111
{

pkgs/sdk/server-ai/src/Interfaces/ILdAiClient.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public interface ILdAiClient
1010
{
1111

1212
/// <summary>
13-
/// Retrieves a LaunchDarkly AI config identified by the given key. The return value
13+
/// Retrieves a LaunchDarkly AI Config identified by the given key. The return value
1414
/// is an <see cref="ILdAiConfigTracker"/>, which makes the configuration available and
1515
/// provides convenience methods for generating events related to model usage.
1616
///
@@ -19,11 +19,11 @@ public interface ILdAiClient
1919
/// a prompt message.
2020
///
2121
/// </summary>
22-
/// <param name="key">the AI config key</param>
22+
/// <param name="key">the AI Config key</param>
2323
/// <param name="context">the context</param>
2424
/// <param name="defaultValue">the default config, if unable to retrieve from LaunchDarkly</param>
2525
/// <param name="variables">the list of variables used when interpolating the prompt</param>
26-
/// <returns>an AI config tracker</returns>
26+
/// <returns>an AI Config tracker</returns>
2727
public ILdAiConfigTracker Config(string key, Context context, LdAiConfig defaultValue,
2828
IReadOnlyDictionary<string, object> variables = null);
2929
}

pkgs/sdk/server-ai/src/LdAiClient.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
namespace LaunchDarkly.Sdk.Server.Ai;
1313

1414
/// <summary>
15-
/// The LaunchDarkly AI client. The client is capable of retrieving AI configurations from LaunchDarkly,
16-
/// and generating events specific to usage of the AI configuration when interacting with model providers.
15+
/// The LaunchDarkly AI client. The client is capable of retrieving AI Configs from LaunchDarkly,
16+
/// and generating events specific to usage of the AI Config when interacting with model providers.
1717
/// </summary>
1818
public sealed class LdAiClient : ILdAiClient
1919
{

pkgs/sdk/server-ai/src/LdAiConfigTracker.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
namespace LaunchDarkly.Sdk.Server.Ai;
1111

1212
/// <summary>
13-
/// A tracker capable of reporting events related to a particular AI configuration.
13+
/// A tracker capable of reporting events related to a particular AI Config.
1414
/// </summary>
1515
public class LdAiConfigTracker : ILdAiConfigTracker
1616
{
@@ -30,12 +30,12 @@ public class LdAiConfigTracker : ILdAiConfigTracker
3030
private const string TimeToFirstToken = "$ld:ai:tokens:ttf";
3131

3232
/// <summary>
33-
/// Constructs a new AI configuration tracker. The tracker is associated with a configuration,
33+
/// Constructs a new AI Config tracker. The tracker is associated with a configuration,
3434
/// a context, and a key which identifies the configuration.
3535
/// </summary>
3636
/// <param name="client">the LaunchDarkly client</param>
37-
/// <param name="configKey">key of the AI config</param>
38-
/// <param name="config">the AI config</param>
37+
/// <param name="configKey">key of the AI Config</param>
38+
/// <param name="config">the AI Config</param>
3939
/// <param name="context">the context</param>
4040
/// <exception cref="ArgumentNullException"></exception>
4141
public LdAiConfigTracker(ILaunchDarklyClient client, string configKey, LdAiConfig config, Context context)
@@ -71,7 +71,7 @@ public async Task<T> TrackDurationOfTask<T>(Task<T> task)
7171
TrackDuration(sw.ElapsedMilliseconds);
7272
}
7373
}
74-
74+
7575
/// <inheritdoc/>
7676
public void TrackTimeToFirstToken(float timeToFirstTokenMs) =>
7777
_client.Track(TimeToFirstToken, _context, _trackData, timeToFirstTokenMs);

0 commit comments

Comments
 (0)