feat: support dependency injection

this is a breaking change, it is not backwards compatible

closes OkGoDoIt#41

Author: KeithHenry

OpenAI_API/APIAuthentication.cs

@@ -157,34 +157,6 @@ public static APIAuthentication LoadFromPath(string directory = null, string fil
 
 			return new APIAuthentication(key, org);
 		}
-
-
-		/// <summary>
-		/// Tests the api key against the OpenAI API, to ensure it is valid.  This hits the models endpoint so should not be charged for usage.
-		/// </summary>
-		/// <returns><see langword="true"/> if the api key is valid, or <see langword="false"/> if empty or not accepted by the OpenAI API.</returns>
-		public async Task<bool> ValidateAPIKey()
-		{
-			if (string.IsNullOrEmpty(ApiKey))
-				return false;
-
-			var api = new OpenAIAPI(this);
-
-			List<Models.Model> results;
-
-			try
-			{
-				results = await api.Models.GetModelsAsync();
-			}
-			catch (Exception ex)
-			{
-				Debug.WriteLine(ex.ToString());
-				return false;
-			}
-
-			return (results.Count > 0);
-		}
-
 	}
 
 	internal static class AuthHelpers

OpenAI_API/EndpointBase.cs

@@ -48,22 +48,19 @@ protected string Url
 			}
 		}
 
-		/// <summary>
-		/// Gets an HTTPClient with the appropriate authorization and other headers set
-		/// </summary>
+		/// <summary>Configures an HttpClient with the appropriate authorization and other headers set</summary>
 		/// <returns>The fully initialized HttpClient</returns>
 		/// <exception cref="AuthenticationException">Thrown if there is no valid authentication.  Please refer to <see href="https://github.com/OkGoDoIt/OpenAI-API-dotnet#authentication"/> for details.</exception>
-		protected HttpClient GetClient()
+		internal static HttpClient ConfigureClient(HttpClient client, APIAuthentication auth)
 		{
-			if (_Api.Auth?.ApiKey is null)
+			if (auth?.ApiKey is null)
 			{
 				throw new AuthenticationException("You must provide API authentication.  Please refer to https://github.com/OkGoDoIt/OpenAI-API-dotnet#authentication for details.");
 			}
 
-			HttpClient client = new HttpClient();
-			client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", _Api.Auth.ApiKey);
+			client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", auth.ApiKey);
 			client.DefaultRequestHeaders.Add("User-Agent", Value);
-			if (!string.IsNullOrEmpty(_Api.Auth.OpenAIOrganization)) client.DefaultRequestHeaders.Add("OpenAI-Organization", _Api.Auth.OpenAIOrganization);
+			if (!string.IsNullOrEmpty(auth.OpenAIOrganization)) client.DefaultRequestHeaders.Add("OpenAI-Organization", auth.OpenAIOrganization);
 
 			return client;
 		}
@@ -99,8 +96,6 @@ private async Task<HttpResponseMessage> HttpRequestRaw(string url = null, HttpMe
 			if (verb == null)
 				verb = HttpMethod.Get;
 
-			var client = GetClient();
-
 			HttpResponseMessage response = null;
 			string resultAsString = null;
 			HttpRequestMessage req = new HttpRequestMessage(verb, url);
@@ -118,7 +113,7 @@ private async Task<HttpResponseMessage> HttpRequestRaw(string url = null, HttpMe
 					req.Content = stringContent;
 				}
 			}
-			response = await client.SendAsync(req, streaming ? HttpCompletionOption.ResponseHeadersRead : HttpCompletionOption.ResponseContentRead);
+			response = await this._Api.Client.SendAsync(req, streaming ? HttpCompletionOption.ResponseHeadersRead : HttpCompletionOption.ResponseContentRead);
 
 			if (response.IsSuccessStatusCode)
 			{

OpenAI_API/IOpenAI.cs

@@ -0,0 +1,23 @@
+#nullable enable
+namespace OpenAI_API;
+using OpenAI_API.Completions;
+using OpenAI_API.Embedding;
+using OpenAI_API.Files;
+using OpenAI_API.Models;
+
+/// <summary>Entry point to the OpenAPI API, handling auth and allowing access to the various API endpoints</summary>
+public interface IOpenAI
+{
+	/// <summary>Text generation is the core function of the API. You give the API a prompt, and it generates a completion. The way you “program” the API to do a task is by simply describing the task in plain english or providing a few written examples. This simple approach works for a wide range of use cases, including summarization, translation, grammar correction, question answering, chatbots, composing emails, and much more (see the prompt library for inspiration).</summary>
+	public CompletionEndpoint Completions { get; }
+
+	/// <summary>The API lets you transform text into a vector (list) of floating point numbers. The distance between two vectors measures their relatedness. Small distances suggest high relatedness and large distances suggest low relatedness.</summary>
+	public EmbeddingEndpoint Embeddings { get; }
+
+	/// <summary>The API endpoint for querying available Engines/models</summary>
+	public ModelsEndpoint Models { get; }
+
+	/// <summary>The API lets you do operations with files. You can upload, delete or retrieve files. Files can be used for fine-tuning, search, etc.</summary>
+	public FilesEndpoint Files { get; }
+}
+

OpenAI_API/OpenAIAPI.cs

@@ -1,36 +1,37 @@
-using OpenAI_API.Completions;
+using Microsoft.Extensions.Logging;
+using OpenAI_API.Completions;
 using OpenAI_API.Embedding;
 using OpenAI_API.Files;
 using OpenAI_API.Models;
+using System.Net.Http;
 
 namespace OpenAI_API
 {
 	/// <summary>
 	/// Entry point to the OpenAPI API, handling auth and allowing access to the various API endpoints
 	/// </summary>
-	public class OpenAIAPI
-	{
+	public class OpenAIAPI: IOpenAI
+    {
 		/// <summary>
 		/// Base url for OpenAI
 		/// </summary>
 		public string ApiUrlBase = "https://api.openai.com/v1/";
-		
-		/// <summary>
-		/// The API authentication information to use for API calls
-		/// </summary>
-		public APIAuthentication Auth { get; set; }
 
-		/// <summary>
-		/// Creates a new entry point to the OpenAPI API, handling auth and allowing access to the various API endpoints
-		/// </summary>
-		/// <param name="apiKeys">The API authentication information to use for API calls, or <see langword="null"/> to attempt to use the <see cref="APIAuthentication.Default"/>, potentially loading from environment vars or from a config file.</param>
-		public OpenAIAPI(APIAuthentication apiKeys = null)
+        /// <summary>The HTTP client configured with the authentication headers.</summary>
+        internal HttpClient Client { get; }
+
+        /// <summary>
+        /// Creates a new entry point to the OpenAPI API, handling auth and allowing access to the various API endpoints
+        /// </summary>
+        /// <param name="httpClient">The HTTP client configured with the authentication headers.</param>
+        public OpenAIAPI(
+			HttpClient httpClient)
 		{
-			this.Auth = apiKeys.ThisOrDefault();
-			Completions = new CompletionEndpoint(this);
-			Models = new ModelsEndpoint(this);
-			Files = new FilesEndpoint(this);
-			Embeddings = new EmbeddingEndpoint(this);
+			this.Client = httpClient;
+			this.Completions = new CompletionEndpoint(this);
+			this.Models = new ModelsEndpoint(this);
+			this.Files = new FilesEndpoint(this);
+			this.Embeddings = new EmbeddingEndpoint(this);
 		}
 
 		/// <summary>
@@ -52,8 +53,5 @@ public OpenAIAPI(APIAuthentication apiKeys = null)
 		/// The API lets you do operations with files. You can upload, delete or retrieve files. Files can be used for fine-tuning, search, etc.
 		/// </summary>
 		public FilesEndpoint Files { get; }
-
-
-
 	}
 }

OpenAI_API/OpenAIApiExtensions.cs

@@ -0,0 +1,31 @@
+#nullable enable
+namespace Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Configuration;
+using OpenAI_API;
+
+static class OpenAIApiExtensions
+{
+    /// <summary>Register <see cref="IOpenAI"/> for DI services. Read configuration from appsettings <code>"openAI": { "key": "", "org": "" }</code></summary>
+    /// <param name="services"></param>
+    /// <param name="configuration"></param>
+    /// <returns></returns>
+    public static IServiceCollection AddOpenAIService(this IServiceCollection services, IConfiguration configuration)
+    {
+        var section = configuration.GetSection("openAI");
+        if (!section.Exists()) return services;
+
+        string? key = section["key"];
+        if (key is null) return services;
+
+        string? organisation = section["org"];
+        return services.AddOpenAIService(new APIAuthentication(key, organisation));
+    }
+
+    public static IServiceCollection AddOpenAIService(this IServiceCollection services, APIAuthentication auth)
+    {
+        services.AddHttpClient<IOpenAI, OpenAIAPI>(client =>
+            EndpointBase.ConfigureClient(client, auth));
+
+        return services;
+    }
+}

OpenAI_API/OpenAI_API.csproj

@@ -1,8 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFramework>netstandard2.0</TargetFramework>
-		<LangVersion>8.0</LangVersion>
+		<TargetFramework>net7.0</TargetFramework>
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 		<Authors>OkGoDoIt (Roger Pincombe)</Authors>
 		<Product>OpenAI API</Product>
@@ -30,7 +29,8 @@
 		<SymbolPackageFormat>snupkg</SymbolPackageFormat>
 
 		<Deterministic>true</Deterministic>
-
+    <ImplicitUsings>enable</ImplicitUsings>
+    <LangVersion>latest</LangVersion>
 	</PropertyGroup>
 
 	<ItemGroup>
@@ -41,7 +41,10 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="1.1.1" />
+		<PackageReference Include="Microsoft.AspNetCore.Http.Extensions" Version="2.2.0" />
+		<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="7.0.0" />
+		<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="7.0.0" />
+		<PackageReference Include="Microsoft.Extensions.Http" Version="7.0.0" />
 		<PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
 		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
 	</ItemGroup>