.Net: Adding Config classes for use with IKernelBuilder and IServiceCollection

dotnet/src/Connectors/Connectors.OpenAI/Configuration/AzureOpenAIApiKeyConfig.cs

@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+namespace Microsoft.SemanticKernel;
+
+public class AzureOpenAIApiKeyConfig : AzureOpenAIConfig
+{
+    /// <summary>
+    /// API key  required by the service.
+    /// </summary>
+    public string ApiKey { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Verify that the current state is valid.
+    /// </summary>
+    public override void Validate()
+    {
+        base.Validate();
+
+        if (string.IsNullOrWhiteSpace(this.ApiKey))
+        {
+            throw new ConfigurationException($"Azure OpenAI: {nameof(this.ApiKey)} is empty");
+        }
+    }
+}

dotnet/src/Connectors/Connectors.OpenAI/Configuration/AzureOpenAIConfig.cs

@@ -0,0 +1,61 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System;
+
+namespace Microsoft.SemanticKernel;
+
+public abstract class AzureOpenAIConfig
+{
+    /// <summary>
+    /// Azure OpenAI endpoint URL.
+    /// </summary>
+    public string Endpoint { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Azure OpenAI deployment name.
+    /// </summary>
+    public string Deployment { get; set; } = string.Empty;
+
+    /// <summary>
+    /// The number of dimensions output embeddings should have.
+    /// Only supported in "text-embedding-3" and later models developed with
+    /// MRL, see https://arxiv.org/abs/2205.13147
+    /// </summary>
+    public int? EmbeddingDimensions { get; set; }
+
+    /// <summary>
+    /// Azure OpenAI API version.
+    /// </summary>
+    public string ApiVersion { get; set; } = string.Empty;
+
+    /// <summary>
+    /// A local identifier for the given AI service.
+    /// </summary>
+    public string ServiceId { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Verify that the current state is valid.
+    /// </summary>
+    public virtual void Validate()
+    {
+        if (string.IsNullOrWhiteSpace(this.Endpoint))
+        {
+            throw new ConfigurationException($"Azure OpenAI: {nameof(this.Endpoint)} is empty");
+        }
+
+        if (!this.Endpoint.StartsWith("https://", StringComparison.OrdinalIgnoreCase))
+        {
+            throw new ConfigurationException($"Azure OpenAI: {nameof(this.Endpoint)} must start with https://");
+        }
+
+        if (string.IsNullOrWhiteSpace(this.Deployment))
+        {
+            throw new ConfigurationException($"Azure OpenAI: {nameof(this.Deployment)} (deployment name) is empty");
+        }
+
+        if (this.EmbeddingDimensions is < 1)
+        {
+            throw new ConfigurationException($"Azure OpenAI: {nameof(this.EmbeddingDimensions)} cannot be less than 1");
+        }
+    }
+}

dotnet/src/Connectors/Connectors.OpenAI/Configuration/AzureOpenAITokenConfig.cs

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Azure.Core;
+
+namespace Microsoft.SemanticKernel;
+
+public class AzureOpenAITokenConfig : AzureOpenAIConfig
+{
+    /// <summary>
+    /// Token credential required by the service.
+    /// </summary>
+    public TokenCredential? TokenCredential { get; set; }
+
+    /// <summary>
+    /// Verify that the current state is valid.
+    /// </summary>
+    public override void Validate()
+    {
+        base.Validate();
+
+        if (this.TokenCredential is null)
+        {
+            throw new ConfigurationException($"Azure OpenAI: {nameof(this.TokenCredential)} is null");
+        }
+    }
+}

dotnet/src/Connectors/Connectors.OpenAI/Configuration/OpenAIConfig.cs

@@ -0,0 +1,75 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System.Text.Json.Serialization;
+
+namespace Microsoft.SemanticKernel;
+
+/// <summary>
+/// OpenAI settings.
+/// </summary>
+public class OpenAIConfig
+{
+    [JsonConverter(typeof(JsonStringEnumConverter))]
+    public enum TextGenerationTypes
+    {
+        Auto = 0,
+        TextCompletion,
+        Chat,
+    }
+
+    /// <summary>
+    /// Model used for text generation. Chat models can be used too.
+    /// </summary>
+    public string TextModel { get; set; } = string.Empty;
+
+    /// <summary>
+    /// The type of OpenAI completion to use, either Text (legacy) or Chat.
+    /// When using Auto, the client uses OpenAI model names to detect the correct protocol.
+    /// Most OpenAI models use Chat. If you're using a non-OpenAI model, you might want to set this manually.
+    /// </summary>
+    public TextGenerationTypes TextGenerationType { get; set; } = TextGenerationTypes.Auto;
+
+    /// <summary>
+    /// Model used to embedding generation.
+    /// </summary>
+    public string EmbeddingModel { get; set; } = string.Empty;
+
+    /// <summary>
+    /// OpenAI HTTP endpoint. You may need to override this to work with
+    /// OpenAI compatible services like LM Studio.
+    /// </summary>
+    public string Endpoint { get; set; } = "https://api.openai.com/v1";
+
+    /// <summary>
+    /// OpenAI API key.
+    /// </summary>
+    public string ApiKey { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Optional OpenAI Organization ID.
+    /// </summary>
+    public string? OrgId { get; set; } = string.Empty;
+
+    /// <summary>
+    /// The number of dimensions output embeddings should have.
+    /// Only supported in "text-embedding-3" and later models developed with
+    /// MRL, see https://arxiv.org/abs/2205.13147
+    /// </summary>
+    public int? EmbeddingDimensions { get; set; }
+
+    /// <summary>
+    /// Verify that the current state is valid.
+    /// </summary>
+    public void Validate()
+    {
+        if (string.IsNullOrWhiteSpace(this.ApiKey))
+        {
+            throw new ConfigurationException($"OpenAI: {nameof(this.ApiKey)} is empty");
+        }
+
+        if (this.EmbeddingDimensions is < 1)
+        {
+            throw new ConfigurationException($"OpenAI: {nameof(this.EmbeddingDimensions)} cannot be less than 1");
+        }
+    }
+}

dotnet/src/Connectors/Connectors.OpenAI/Connectors.OpenAI.csproj

@@ -30,5 +30,6 @@
 
   <ItemGroup>
     <PackageReference Include="Azure.AI.OpenAI" />
+    <PackageReference Include="Azure.Identity" />
   </ItemGroup>
 </Project>