|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Data.Common;
using Aspire.Azure.Common;
using Azure.Core;
using Microsoft.Identity.Client.Platforms.Features.DesktopOs.Kerberos;
namespace Microsoft.Extensions.Hosting;
/// <summary>
/// Represents configuration settings for Azure AI Chat Completions client.
/// </summary>
public sealed class ChatCompletionsClientSettings : IConnectionStringSettings
{
private bool? _disableTracing;
/// <summary>
/// Gets or sets the connection string used to connect to the AI Foundry account.
/// </summary>
/// <remarks>
/// If <see cref="ConnectionString"/> is set, it overrides <see cref="Endpoint"/>, <see cref="DeploymentId"/> and <see cref="Credential"/>.
/// </remarks>
public string? ConnectionString { get; set; }
/// <summary>
/// Gets or sets the ID of the AI model deployment to use for chat completions.
/// </summary>
public string? DeploymentId { get; set; }
/// <summary>
/// Gets or sets the endpoint URI for the Azure AI service.
/// </summary>
public Uri? Endpoint { get; set; }
/// <summary>
/// Gets or sets the token credential used for Azure authentication.
/// </summary>
public TokenCredential? TokenCredential { get; set; }
/// <summary>
/// Gets or sets the API key used for authentication with the Azure AI service.
/// </summary>
public string? Key { get; set; }
/// <summary>
/// Gets or sets a boolean value that indicates whether the OpenTelemetry metrics are enabled or not.
/// </summary>
/// <remarks>
/// /// Azure AI Inference telemetry follows the pattern of Azure SDKs Diagnostics.
/// </remarks>
public bool DisableMetrics { get; set; }
/// <summary>
/// Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.
/// </summary>
/// <remarks>
/// Azure AI Inference client library ActivitySource support in Azure SDK is experimental, the shape of Activities may change in the future without notice.
/// It can be enabled by setting "Azure.Experimental.EnableActivitySource" <see cref="AppContext"/> switch to true.
/// Or by setting "AZURE_EXPERIMENTAL_ENABLE_ACTIVITY_SOURCE" environment variable to "true".
/// </remarks>
/// <value>
/// The default value is <see langword="false"/>.
/// </value>
public bool DisableTracing
{
get { return _disableTracing ??= !GetTracingDefaultValue(); }
set { _disableTracing = value; }
}
// Defaults DisableTracing to false if the experimental switch is set
// TODO: remove this when ActivitySource support is no longer experimental
private static bool GetTracingDefaultValue()
{
if (AppContext.TryGetSwitch("Azure.Experimental.EnableActivitySource", out var enabled))
{
return enabled;
}
var envVar = Environment.GetEnvironmentVariable("AZURE_EXPERIMENTAL_ENABLE_ACTIVITY_SOURCE");
if (envVar is not null && (envVar.Equals("true", StringComparison.OrdinalIgnoreCase) || envVar.Equals("1")))
{
return true;
}
return false;
}
/// <summary>
/// Parses a connection string and populates the settings properties.
/// </summary>
/// <param name="connectionString">The connection string containing configuration values.</param>
/// <remarks>
/// The connection string can contain the following keys:
/// - DeploymentId: The ID of the AI model
/// - Endpoint: The service endpoint URI
/// - Key: The API key for authentication
/// </remarks>
void IConnectionStringSettings.ParseConnectionString(string? connectionString)
{
var connectionBuilder = new DbConnectionStringBuilder
{
ConnectionString = connectionString
};
if (connectionBuilder.TryGetValue(nameof(DeploymentId), out var modelId))
{
DeploymentId = modelId.ToString();
}
if (connectionBuilder.TryGetValue(nameof(Endpoint), out var endpoint) && Uri.TryCreate(endpoint.ToString(), UriKind.Absolute, out var serviceUri))
{
Endpoint = serviceUri;
}
if (connectionBuilder.TryGetValue(nameof(Key), out var key) && !string.IsNullOrWhiteSpace(key.ToString()))
{
Key = key.ToString();
}
}
}
|