|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.ClientModel;
using System.Data.Common;
using Aspire.Azure.Common;
using Azure.Core;
namespace Aspire.Azure.AI.OpenAI;
/// <summary>
/// The settings relevant to accessing Azure OpenAI or OpenAI.
/// </summary>
public sealed class AzureOpenAISettings : IConnectionStringSettings
{
private const string ConnectionStringEndpoint = "Endpoint";
private const string ConnectionStringKey = "Key";
/// <summary>
/// Gets or sets a <see cref="Uri"/> referencing the Azure OpenAI endpoint.
/// This is likely to be similar to "https://{account_name}.openai.azure.com".
/// </summary>
/// <remarks>
/// Leave empty and provide a <see cref="Key"/> value to use a non-Azure OpenAI inference endpoint.
/// Used along with <see cref="Credential"/> or <see cref="Key"/> to establish the connection.
/// </remarks>
public Uri? Endpoint { get; set; }
/// <summary>
/// Gets or sets the credential used to authenticate to the Azure OpenAI resource.
/// </summary>
public TokenCredential? Credential { get; set; }
/// <summary>
/// Gets or sets the key to use to authenticate to the Azure OpenAI endpoint.
/// </summary>
/// <remarks>
/// When defined it will use an <see cref="ApiKeyCredential"/> instance instead of <see cref="Credential"/>.
/// </remarks>
public string? Key { get; set; }
/// <summary>
/// Gets or sets a boolean value that indicates whether the OpenTelemetry metrics are enabled or not.
/// </summary>
/// <remarks>
/// Telemetry is recorded by Microsoft.Extensions.AI.
/// </remarks>
/// <value>
/// The default value is <see langword="false"/>.
/// </value>
public bool DisableMetrics { get; set; }
/// <summary>
/// Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.
/// </summary>
/// <remarks>
/// Telemetry is recorded by Microsoft.Extensions.AI.
/// </remarks>
/// <value>
/// The default value is <see langword="false"/>.
/// </value>
public bool DisableTracing { get; set; }
/// <summary>
/// Gets or sets a boolean value indicating whether potentially sensitive information should be included in telemetry.
/// </summary>
/// <value>
/// <see langword="true"/> if potentially sensitive information should be included in telemetry;
/// <see langword="false"/> if telemetry shouldn't include raw inputs and outputs.
/// The default value is <see langword="false"/>.
/// </value>
/// <remarks>
/// By default, telemetry includes metadata, such as token counts, but not raw inputs
/// and outputs, such as message content, function call arguments, and function call results.
/// </remarks>
public bool EnableSensitiveTelemetryData { get; set; }
void IConnectionStringSettings.ParseConnectionString(string? connectionString)
{
if (Uri.TryCreate(connectionString, UriKind.Absolute, out var uri))
{
Endpoint = uri;
}
else
{
var connectionBuilder = new DbConnectionStringBuilder
{
ConnectionString = connectionString
};
if (connectionBuilder.ContainsKey(ConnectionStringEndpoint) && Uri.TryCreate(connectionBuilder[ConnectionStringEndpoint].ToString(), UriKind.Absolute, out var serviceUri))
{
Endpoint = serviceUri;
}
if (connectionBuilder.ContainsKey(ConnectionStringKey))
{
Key = connectionBuilder[ConnectionStringKey].ToString();
}
}
}
}
|