Add deterministic seeds

Author: OkGoDoIt

OpenAI_API/Chat/ChatRequest.cs

@@ -145,6 +145,12 @@ internal Dictionary<string, string> ResponseFormatRaw
 			}
 		}
 
+		/// <summary>
+		/// If specified, OpenAI will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the <see cref="ChatResult.SystemFingerprint"/> response parameter to monitor changes in the backend.
+		/// </summary>
+		[JsonProperty("seed", DefaultValueHandling=DefaultValueHandling.Ignore)]
+		public int? Seed { get; set; }
+
 		/// <summary>
 		/// Creates a new, empty <see cref="ChatRequest"/>
 		/// </summary>

OpenAI_API/Chat/ChatResult.cs

@@ -39,6 +39,12 @@ public override string ToString()
 			else
 				return null;
 		}
+
+		/// <summary>
+		/// This fingerprint represents the backend configuration that the model runs with. It can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.This is the indicator on whether users should expect "almost always the same result".
+		/// </summary>
+		[JsonProperty("system_fingerprint")]
+		public string SystemFingerprint { get; set; }
 	}
 
 	/// <summary>

OpenAI_API/Completions/CompletionRequest.cs

@@ -162,7 +162,7 @@ public string StopSequence
 		public string user { get; set; }
 
 		/// <summary>
-		/// Cretes a new, empty <see cref="CompletionRequest"/>
+		/// Creates a new, empty <see cref="CompletionRequest"/>
 		/// </summary>
 		public CompletionRequest()
 		{

OpenAI_API/Model/Model.cs

@@ -144,16 +144,21 @@ public async Task<Model> RetrieveModelDetailsAsync(OpenAI_API.OpenAIAPI api)
 		///	The latest GPT-4 model with improved instruction following, JSON mode, reproducible outputs, parallel function calling, and more. Returns a maximum of 4,096 output tokens. This preview model is not yet suited for production traffic. 
 		/// </summary>
 		public static Model GPT4_Turbo => new Model("gpt-4-1106-preview") { OwnedBy = "openai" };
-#endregion
+		#endregion
 
-#region GPT-3.5
+		#region GPT-3.5
 		/// <summary>
-		/// Most capable GPT-3.5 model and optimized for chat at 1/10th the cost of text-davinci-003. Will be updated with the latest model iteration.
+		/// GPT-3.5 Turbo model which regularly updates with the latest model iteration.
 		/// </summary>
 		public static Model ChatGPTTurbo => new Model("gpt-3.5-turbo") { OwnedBy = "openai" };
 
 		/// <summary>
-		/// The latest GPT-3.5 Turbo model with 16k context window, improved instruction following, JSON mode, reproducible outputs, parallel function calling, and more. Returns a maximum of 4,096 output tokens.
+		/// The latest GPT-3.5 Turbo model with improved instruction following, JSON mode, reproducible outputs, parallel function calling, and more. Returns a maximum of 4,096 output tokens.
+		/// </summary>
+		public static Model ChatGPTTurbo_1106 => new Model("gpt-3.5-turbo-1106") { OwnedBy = "openai" };
+
+		/// <summary>
+		/// GPT-3.5 Turbo model with 16k context window, improved instruction following.
 		/// </summary>
 		public static Model ChatGPTTurbo_16k => new Model("gpt-3.5-turbo-16k") { OwnedBy = "openai" };
 

OpenAI_Tests/ChatEndpointTests.cs

@@ -496,5 +496,75 @@ public void ChatJsonFormat(string model)
 			}
 
 		}
+
+		[Test]
+		public async Task SameSeedShouldBeSameOutput() {
+			var api = new OpenAI_API.OpenAIAPI();
+			ChatRequest chatRequest = new ChatRequest()
+			{
+				Model = Model.ChatGPTTurbo_1106,
+				Temperature = 0,
+				MaxTokens = 100,
+				Seed = 5,
+				Messages = new ChatMessage[] {
+					new ChatMessage(ChatMessageRole.System, "You are a very creative comedian."),
+					new ChatMessage(ChatMessageRole.User, "Tell me a joke.")
+				}
+			};
+			var resultA = await api.Chat.CreateChatCompletionAsync(chatRequest);
+			string jokeA = resultA.ToString();
+			string systemFingerprintA = resultA.SystemFingerprint;
+			Assert.IsNotNull(systemFingerprintA);
+			Assert.IsNotEmpty(systemFingerprintA);
+			Assert.IsNotEmpty(jokeA);
+
+			var resultB = await api.Chat.CreateChatCompletionAsync(chatRequest);
+			string jokeB = resultB.ToString();
+			string systemFingerprintB = resultB.SystemFingerprint;
+			Assert.IsNotNull(systemFingerprintB);
+			Assert.IsNotEmpty(systemFingerprintB);
+			Assert.IsNotEmpty(jokeB);
+
+			if (systemFingerprintA == systemFingerprintB)
+			{
+				Assert.AreEqual(jokeA, jokeB);
+			}
+		}
+
+		[Test]
+		public async Task DifferentSeedShouldBeDifferentOutput()
+		{
+			var api = new OpenAI_API.OpenAIAPI();
+			ChatRequest chatRequest = new ChatRequest()
+			{
+				Model = Model.ChatGPTTurbo_1106,
+				Temperature = 0,
+				MaxTokens = 100,
+				Seed = 5,
+				Messages = new ChatMessage[] {
+					new ChatMessage(ChatMessageRole.System, "You are a very creative comedian."),
+					new ChatMessage(ChatMessageRole.User, "Tell me a joke.")
+				}
+			};
+			var resultA = await api.Chat.CreateChatCompletionAsync(chatRequest);
+			string jokeA = resultA.ToString();
+			string systemFingerprintA = resultA.SystemFingerprint;
+			Assert.IsNotNull(systemFingerprintA);
+			Assert.IsNotEmpty(systemFingerprintA);
+			Assert.IsNotEmpty(jokeA);
+
+			chatRequest.Seed = 99;
+			var resultB = await api.Chat.CreateChatCompletionAsync(chatRequest);
+			string jokeB = resultB.ToString();
+			string systemFingerprintB = resultB.SystemFingerprint;
+			Assert.IsNotNull(systemFingerprintB);
+			Assert.IsNotEmpty(systemFingerprintB);
+			Assert.IsNotEmpty(jokeB);
+
+			if (systemFingerprintA == systemFingerprintB)
+			{
+				Assert.AreNotEqual(jokeA, jokeB);
+			}
+		}
 	}
 }