Improve chat conversations and testing

Author: OkGoDoIt

OpenAI_API/Chat/ChatEndpoint.cs

@@ -32,10 +32,11 @@ internal ChatEndpoint(OpenAIAPI api) : base(api) { }
 		/// <summary>
 		/// Creates an ongoing chat which can easily encapsulate the conversation.  This is the simplest way to use the Chat endpoint.
 		/// </summary>
+		/// <param name="defaultChatRequestArgs">Allows setting the parameters to use when calling the ChatGPT API.  Can be useful for setting temperature, presence_penalty, and more.  See <see href="https://platform.openai.com/docs/api-reference/chat/create">OpenAI documentation for a list of possible parameters to tweak.</see></param>
 		/// <returns></returns>
-		public Conversation CreateConversation()
+		public Conversation CreateConversation(ChatRequest defaultChatRequestArgs = null)
 		{
-			return new Conversation(this, defaultChatRequestArgs: DefaultChatRequestArgs);
+			return new Conversation(this, defaultChatRequestArgs: defaultChatRequestArgs ?? DefaultChatRequestArgs);
 		}
 
 		#region Non-streaming

OpenAI_API/Chat/Conversation.cs

@@ -49,7 +49,7 @@ public OpenAI_API.Models.Model Model
 		/// </summary>
 		/// <param name="endpoint">A reference to the API endpoint, needed for API requests.  Generally should be <see cref="OpenAIAPI.Chat"/>.</param>
 		/// <param name="model">Optionally specify the model to use for ChatGPT requests.  If not specified, used <paramref name="defaultChatRequestArgs"/>.Model or falls back to <see cref="OpenAI_API.Models.Model.ChatGPTTurbo"/></param>
-		/// <param name="defaultChatRequestArgs">Allows setting the parameters to use when calling the ChatGPT API.  Can be useful for setting temperature, presence_penalty, and more.  <see href="https://platform.openai.com/docs/api-reference/chat/create">Se  OpenAI documentation for a list of possible parameters to tweak.</see></param>
+		/// <param name="defaultChatRequestArgs">Allows setting the parameters to use when calling the ChatGPT API.  Can be useful for setting temperature, presence_penalty, and more.  See <see href="https://platform.openai.com/docs/api-reference/chat/create">OpenAI documentation for a list of possible parameters to tweak.</see></param>
 		public Conversation(ChatEndpoint endpoint, OpenAI_API.Models.Model model = null, ChatRequest defaultChatRequestArgs = null)
 		{
 			RequestParameters = new ChatRequest(defaultChatRequestArgs);
@@ -102,6 +102,8 @@ public void AppendMessage(ChatMessage message)
 		/// <param name="content">Text content written by a developer to help give examples of desired behavior</param>
 		public void AppendExampleChatbotOutput(string content) => this.AppendMessage(new ChatMessage(ChatMessageRole.Assistant, content));
 
+		#region Non-streaming
+
 		/// <summary>
 		/// Calls the API to get a response, which is appended to the current chat's <see cref="Messages"/> as an <see cref="ChatMessageRole.Assistant"/> <see cref="ChatMessage"/>.
 		/// </summary>
@@ -117,12 +119,16 @@ public async Task<string> GetResponseFromChatbot()
 			if (res.Choices.Count > 0)
 			{
 				var newMsg = res.Choices[0].Message;
-				AppendMessage(res.Choices[0].Message);
-				return res.Choices[0].Message.Content;
+				AppendMessage(newMsg);
+				return newMsg.Content;
 			}
 			return null;
 		}
 
+		#endregion
+
+		#region Streaming
+
 		/// <summary>
 		/// Calls the API to get a response, which is appended to the current chat's <see cref="Messages"/> as an <see cref="ChatMessageRole.Assistant"/> <see cref="ChatMessage"/>, and streams the results to the <paramref name="resultHandler"/> as they come in. <br/>
 		/// If you are on the latest C# supporting async enumerables, you may prefer the cleaner syntax of <see cref="StreamResponseEnumerableFromChatbotAsync"/> instead.
@@ -136,6 +142,20 @@ public async Task StreamResponseFromChatbotAsync(Action<string> resultHandler)
 			}
 		}
 
+		/// <summary>
+		/// Calls the API to get a response, which is appended to the current chat's <see cref="Messages"/> as an <see cref="ChatMessageRole.Assistant"/> <see cref="ChatMessage"/>, and streams the results to the <paramref name="resultHandler"/> as they come in. <br/>
+		/// If you are on the latest C# supporting async enumerables, you may prefer the cleaner syntax of <see cref="StreamResponseEnumerableFromChatbotAsync"/> instead.
+		///  </summary>
+		/// <param name="resultHandler">An action to be called as each new result arrives, which includes the index of the result in the overall result set.</param>
+		public async Task StreamResponseFromChatbotAsync(Action<int, string> resultHandler)
+		{
+			int index = 0;
+			await foreach (string res in StreamResponseEnumerableFromChatbotAsync())
+			{
+				resultHandler(index++, res);
+			}
+		}
+
 		/// <summary>
 		/// Calls the API to get a response, which is appended to the current chat's <see cref="Messages"/> as an <see cref="ChatMessageRole.Assistant"/> <see cref="ChatMessage"/>, and streams the results as they come in. <br/>
 		/// If you are not using C# 8 supporting async enumerables or if you are using the .NET Framework, you may need to use <see cref="StreamResponseFromChatbotAsync"/> instead.
@@ -153,7 +173,9 @@ public async IAsyncEnumerable<string> StreamResponseEnumerableFromChatbotAsync()
 			{
 				if (res.Choices.FirstOrDefault()?.Delta is ChatMessage delta)
 				{
-					responseRole = delta.Role;
+					if (delta.Role != null)
+						responseRole = delta.Role;
+
 					string deltaContent = delta.Content;
 
 					if (!string.IsNullOrEmpty(deltaContent))
@@ -162,12 +184,15 @@ public async IAsyncEnumerable<string> StreamResponseEnumerableFromChatbotAsync()
 						yield return deltaContent;
 					}
 				}
+				MostResentAPIResult = res;
 			}
 
 			if (responseRole != null)
 			{
 				AppendMessage(responseRole, responseStringBuilder.ToString());
 			}
 		}
+
+		#endregion
 	}
 }

OpenAI_API/Chat/IChatEndpoint.cs

@@ -17,7 +17,7 @@ public interface IChatEndpoint
 		Task<ChatResult> CreateChatCompletionAsync(IList<ChatMessage> messages, Model model = null, double? temperature = null, double? top_p = null, int? numOutputs = null, int? max_tokens = null, double? frequencyPenalty = null, double? presencePenalty = null, IReadOnlyDictionary<string, float> logitBias = null, params string[] stopSequences);
 		Task<ChatResult> CreateChatCompletionAsync(params ChatMessage[] messages);
 		Task<ChatResult> CreateChatCompletionAsync(params string[] userMessages);
-		Conversation CreateConversation();
+		Conversation CreateConversation(ChatRequest defaultChatRequestArgs = null);
 		Task StreamChatAsync(ChatRequest request, Action<ChatResult> resultHandler);
 		IAsyncEnumerable<ChatResult> StreamChatEnumerableAsync(ChatRequest request);
 		IAsyncEnumerable<ChatResult> StreamChatEnumerableAsync(IList<ChatMessage> messages, Model model = null, double? temperature = null, double? top_p = null, int? numOutputs = null, int? max_tokens = null, double? frequencyPenalty = null, double? presencePenalty = null, IReadOnlyDictionary<string, float> logitBias = null, params string[] stopSequences);

OpenAI_Tests/ChatEndpointTests.cs

@@ -106,11 +106,6 @@ public void ChatBackAndForth()
 			Assert.NotNull(res);
 			Assert.IsNotEmpty(res);
 			Assert.AreEqual("No", res.Trim());
-
-			foreach (ChatMessage msg in chat.Messages)
-			{
-				Console.WriteLine($"{msg.Role}: {msg.Content}");
-			}
 		}
 
 		[Test]
@@ -140,5 +135,37 @@ public async Task StreamCompletionEnumerableAsync_ShouldStreamData()
 			Assert.That(chatResults.Select(cr => cr.Choices[0].Delta.Content).Count(c => !string.IsNullOrEmpty(c)) > 50);
 		}
 
+		[Test]
+		public async Task StreamingConversation()
+		{
+			var api = new OpenAI_API.OpenAIAPI();
+
+			var chat = api.Chat.CreateConversation();
+			chat.RequestParameters.MaxTokens = 500;
+			chat.RequestParameters.Temperature = 0.2;
+			chat.Model = Model.ChatGPTTurbo;
+
+			chat.AppendSystemMessage("You are a helpful assistant who is really good at explaining things to students.");
+			chat.AppendUserInput("Please explain to me how mountains are formed in great detail.");
+
+			string result = "";
+			int streamParts = 0;
+
+			await foreach (var streamResultPart in chat.StreamResponseEnumerableFromChatbotAsync())
+			{
+				result += streamResultPart;
+				streamParts++;
+			}
+
+			Assert.NotNull(result);
+			Assert.IsNotEmpty(result);
+			Assert.That(result.ToLower().Contains("mountains"));
+			Assert.Greater(result.Length, 200);
+			Assert.Greater(streamParts, 5);
+
+			Assert.AreEqual(ChatMessageRole.User, chat.Messages.Last().Role);
+			Assert.AreEqual(result, chat.Messages.Last().Content);
+		}
+
 	}
 }