Update auth to remove secret key and add OpenAI-Organization

Author: OkGoDoIt

OpenAI_API/APIAuthentication.cs

@@ -17,6 +17,10 @@ public class APIAuthentication
 		/// The API key, required to access the API endpoint.
 		/// </summary>
 		public string ApiKey { get; set; }
+        /// <summary>
+        /// The Organization ID to count API requests against.  This can be found at https://beta.openai.com/account/org-settings.
+        /// </summary>
+        public string OpenAIOrganization { get; set; }
 
 		/// <summary>
 		/// Allows implicit casting from a string, so that a simple string API key can be provided in place of an instance of <see cref="APIAuthentication"/>
@@ -36,7 +40,19 @@ public APIAuthentication(string apiKey)
 			this.ApiKey = apiKey;
 		}
 
-		private static APIAuthentication cachedDefault = null;
+
+        /// <summary>
+        /// Instantiates a new Authentication object with the given <paramref name="apiKey"/>, which may be <see langword="null"/>.  For users who belong to multiple organizations, you can specify which organization is used. Usage from these API requests will count against the specified organization's subscription quota.
+        /// </summary>
+        /// <param name="apiKey">The API key, required to access the API endpoint.</param>
+        /// <param name="openAIOrganization">The Organization ID to count API requests against.  This can be found at https://beta.openai.com/account/org-settings.</param>
+        public APIAuthentication(string apiKey, string openAIOrganization)
+        {
+            this.ApiKey = apiKey;
+			this.OpenAIOrganization = openAIOrganization;
+        }
+
+        private static APIAuthentication cachedDefault = null;
 
 		/// <summary>
 		/// The default authentication to use when no other auth is specified.  This can be set manually, or automatically loaded via environment variables or a config file.  <seealso cref="LoadFromEnv"/><seealso cref="LoadFromPath(string, string, bool)"/>
@@ -63,21 +79,25 @@ public static APIAuthentication Default
 			}
 		}
 
-		/// <summary>
-		/// Attempts to load api keys from environment variables, as "OPENAI_KEY" (or "OPENAI_SECRET_KEY", for backwards compatibility)
-		/// </summary>
-		/// <returns>Returns the loaded <see cref="APIAuthentication"/> any api keys were found, or <see langword="null"/> if there were no matching environment vars.</returns>
-		public static APIAuthentication LoadFromEnv()
+        /// <summary>
+        /// Attempts to load api key from environment variables, as "OPENAI_KEY" or "OPENAI_API_KEY".  Also loads org if from "OPENAI_ORGANIZATION" if present.
+        /// </summary>
+        /// <returns>Returns the loaded <see cref="APIAuthentication"/> any api keys were found, or <see langword="null"/> if there were no matching environment vars.</returns>
+        public static APIAuthentication LoadFromEnv()
 		{
-			var key = Environment.GetEnvironmentVariable("OPENAI_KEY");
-			
-			if (string.IsNullOrEmpty(key))
-				key = Environment.GetEnvironmentVariable("OPENAI_SECRET_KEY");
-			
+            string key = Environment.GetEnvironmentVariable("OPENAI_KEY");
+
 			if (string.IsNullOrEmpty(key))
-				return null;
+			{
+                key = Environment.GetEnvironmentVariable("OPENAI_API_KEY");
 
-			return new APIAuthentication(key);
+				if (string.IsNullOrEmpty(key))
+                    return null;
+			}
+
+            string org = Environment.GetEnvironmentVariable("OPENAI_ORGANIZATION");
+
+            return new APIAuthentication(key, org);
 		}
 
 		/// <summary>
@@ -93,6 +113,7 @@ public static APIAuthentication LoadFromPath(string directory = null, string fil
 				directory = Environment.CurrentDirectory;
 
 			string key = null;
+			string org = null;
 			var curDirectory = new DirectoryInfo(directory);
 
 			while (key == null && curDirectory.Parent != null)
@@ -107,13 +128,16 @@ public static APIAuthentication LoadFromPath(string directory = null, string fil
 						{
 							switch (parts[0].ToUpper())
 							{
-								case "OPENAI_KEY":
-									key = parts[1].Trim();
-									break;
-								case "OPENAI_SECRET_KEY":
-									key = parts[1].Trim();
-									break;
-								default:
+                                case "OPENAI_KEY":
+                                    key = parts[1].Trim();
+                                    break;
+                                case "OPENAI_API_KEY":
+                                    key = parts[1].Trim();
+                                    break;
+                                case "OPENAI_ORGANIZATION":
+                                    org = parts[1].Trim();
+                                    break;
+                                default:
 									break;
 							}
 						}
@@ -133,7 +157,7 @@ public static APIAuthentication LoadFromPath(string directory = null, string fil
 			if (string.IsNullOrEmpty(key))
 				return null;
 
-			return new APIAuthentication(key);
+			return new APIAuthentication(key, org);
 		}
 
 

OpenAI_API/Completions/CompletionEndpoint.cs

@@ -49,6 +49,7 @@ public async Task<CompletionResult> CreateCompletionAsync(CompletionRequest requ
 			HttpClient client = new HttpClient();
 			client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", Api.Auth.ApiKey);
 			client.DefaultRequestHeaders.Add("User-Agent", "okgodoit/dotnet_openai_api");
+			if (!string.IsNullOrEmpty(Api.Auth.OpenAIOrganization)) client.DefaultRequestHeaders.Add("OpenAI-Organization", Api.Auth.OpenAIOrganization);
 
 			string jsonContent = JsonConvert.SerializeObject(request, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore });
 			var stringContent = new StringContent(jsonContent, UnicodeEncoding.UTF8, "application/json");

OpenAI_API/Engine/EnginesEndpoint.cs

@@ -55,6 +55,7 @@ public static async Task<List<Engine>> GetEnginesAsync(APIAuthentication auth =
 			HttpClient client = new HttpClient();
 			client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", auth.ThisOrDefault().ApiKey);
 			client.DefaultRequestHeaders.Add("User-Agent", "okgodoit/dotnet_openai_api");
+            if (!string.IsNullOrEmpty(auth.ThisOrDefault().OpenAIOrganization)) client.DefaultRequestHeaders.Add("OpenAI-Organization", auth.ThisOrDefault().OpenAIOrganization);
 
 			var response = await client.GetAsync(@"https://api.openai.com/v1/engines");
 			string resultAsString = await response.Content.ReadAsStringAsync();

OpenAI_API/Search/SearchEndpoint.cs

@@ -43,6 +43,7 @@ public async Task<Dictionary<string, double>> GetSearchResultsAsync(SearchReques
 			HttpClient client = new HttpClient();
 			client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", Api.Auth.ApiKey);
 			client.DefaultRequestHeaders.Add("User-Agent", "okgodoit/dotnet_openai_api");
+            if (!string.IsNullOrEmpty(Api.Auth.OpenAIOrganization)) client.DefaultRequestHeaders.Add("OpenAI-Organization", Api.Auth.OpenAIOrganization);
 
 			string jsonContent = JsonConvert.SerializeObject(request, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore, MissingMemberHandling = MissingMemberHandling.Ignore });
 			var stringContent = new StringContent(jsonContent, UnicodeEncoding.UTF8, "application/json");

OpenAI_Tests/AuthTests.cs

@@ -9,12 +9,12 @@ public class AuthTests
 		[SetUp]
 		public void Setup()
 		{
-			File.WriteAllText(".openai", "OPENAI_KEY=pk-test12");
-			Environment.SetEnvironmentVariable("OPENAI_KEY", "pk-test-env");
-			//Environment.SetEnvironmentVariable("OPENAI_SECRET_KEY", "sk-test-env");
-		}
+			File.WriteAllText(".openai", "OPENAI_KEY=pk-test12"+Environment.NewLine+ "OPENAI_ORGANIZATION=org-testing123");
+            Environment.SetEnvironmentVariable("OPENAI_API_KEY", "pk-test-env");
+            Environment.SetEnvironmentVariable("OPENAI_ORGANIZATION", "org-testing123");
+        }
 
-		[Test]
+        [Test]
 		public void GetAuthFromEnv()
 		{
 			var auth = OpenAI_API.APIAuthentication.LoadFromEnv();
@@ -47,14 +47,20 @@ public void GetDefault()
 		{
 			var auth = OpenAI_API.APIAuthentication.Default;
 			var envAuth = OpenAI_API.APIAuthentication.LoadFromEnv();
-			Assert.IsNotNull(auth);
-			Assert.IsNotNull(auth.ApiKey);
-			Assert.AreEqual(envAuth.ApiKey, auth.ApiKey);
-		}
+            Assert.IsNotNull(auth);
+            Assert.IsNotNull(auth.ApiKey);
+            Assert.IsNotNull(envAuth);
+            Assert.IsNotNull(envAuth.ApiKey);
+            Assert.AreEqual(envAuth.ApiKey, auth.ApiKey);
+            Assert.IsNotNull(auth.OpenAIOrganization);
+            Assert.IsNotNull(envAuth.OpenAIOrganization);
+            Assert.AreEqual(envAuth.OpenAIOrganization, auth.OpenAIOrganization);
 
+        }
 
 
-		[Test]
+
+        [Test]
 		public void testHelper()
 		{
 			OpenAI_API.APIAuthentication defaultAuth = OpenAI_API.APIAuthentication.Default;
@@ -87,13 +93,16 @@ public void ParseKey()
 			var auth = new OpenAI_API.APIAuthentication("pk-testAA");
 			Assert.IsNotNull(auth.ApiKey);
 			Assert.AreEqual("pk-testAA", auth.ApiKey);
+			Assert.IsNull(auth.OpenAIOrganization);
 			auth = "pk-testCC";
 			Assert.IsNotNull(auth.ApiKey);
 			Assert.AreEqual("pk-testCC", auth.ApiKey);
 
-			auth = new OpenAI_API.APIAuthentication("sk-testBB");
+			auth = new OpenAI_API.APIAuthentication("sk-testBB", "orgTest");
 			Assert.IsNotNull(auth.ApiKey);
 			Assert.AreEqual("sk-testBB", auth.ApiKey);
+			Assert.IsNotNull(auth.OpenAIOrganization);
+			Assert.AreEqual("orgTest", auth.OpenAIOrganization);
 		}
 
 	}

README.md

@@ -36,18 +36,18 @@ Install-Package OpenAI
 ### Authentication
 There are 3 ways to provide your API keys, in order of precedence:
 1.  Pass keys directly to `APIAuthentication(string key)` constructor
-2.  Set environment var for OPENAI_KEY
+2.  Set environment var for OPENAI_API_KEY (or OPENAI_KEY for backwards compatability)
 3.  Include a config file in the local directory or in your user directory named `.openai` and containing the line:
 ```shell
-OPENAI_KEY=sk-aaaabbbbbccccddddd
+OPENAI_API_KEY=sk-aaaabbbbbccccddddd
 ```
 
 You use the `APIAuthentication` when you initialize the API as shown:
 ```csharp
 // for example
-OpenAIAPI api = new OpenAIAPI("sk-mykeyhere"); // shorthand
+OpenAIAPI api = new OpenAIAPI("YOUR_API_KEY"); // shorthand
 // or
-OpenAIAPI api = new OpenAIAPI(new APIAuthentication("sk-secretkey")); // create object manually
+OpenAIAPI api = new OpenAIAPI(new APIAuthentication("YOUR_API_KEY")); // create object manually
 // or
 OpenAIAPI api = new OpenAIAPI(APIAuthentication LoadFromEnv()); // use env vars
 // or
@@ -56,6 +56,14 @@ OpenAIAPI api = new OpenAIAPI(APIAuthentication LoadFromPath()); // use config f
 OpenAIAPI api = new OpenAIAPI(); // uses default, env, or config file
 ```
 
+You may optionally include an openAIOrganization (OPENAI_ORGANIZATION in env or config file) specifying which organization is used for an API request. Usage from these API requests will count against the specified organization's subscription quota.  Organization IDs can be found on your [Organization settings](https://beta.openai.com/account/org-settings) page.
+```csharp
+// for example
+OpenAIAPI api = new OpenAIAPI(new APIAuthentication("YOUR_API_KEY","org-yourOrgHere"));
+```
+
+
+
 ### Completions
 The Completion API is accessed via `OpenAIAPI.Completions`: