Add streaming methods for Conversation class

[JasonWei512]

Add streaming methods for Conversation class for convenience.

Using the new C# 8.0 async iterators:

var chat = api.Chat.CreateConversation();
chat.AppendUserInput("How to make a hamburger?");

await foreach (var res in chat.StreamResponseEnumerableFromChatbotAsync())
{
    Console.Write(res);
}

Or if using classic .NET framework or C# <8.0:

var chat = api.Chat.CreateConversationAsync();
chat.AppendUserInput("How to make a hamburger?");

await chat.StreamResponseFromChatbotAsync(res =>
{
    Console.Write(res);
});

[Baklap4]

As i'm not the owner, but just saw this project today and wanted to contribute here's my 50cents...

[Baklap4]

Please use suffix Async

[JasonWei512]

Conversation's async Task<string> GetResponseFromChatbot() doesn't have Async suffix. But some async methods in other classes have. So I am a little bit confused.

[Baklap4]

The majority of the codebase uses Async suffix except for the tests, but you're right aswell. One of the questions i still had when looking through the code :)
Per Microsoft Async suffix should not be used unless you have synchronous AND asynchronous methods for the same functionality. But to not exclude synchronous or create ambiguity it's best practice to suffix it with Async to always have the option open. But yeah it should be consistent heheh. #71 will help with this i guess

[OkGoDoIt]

Sorry, I guess I missed one

[JasonWei512]

I added "Async" suffix

[JasonWei512]

Conversation class already has a GetResponseFromChatbot() method. So I name the stream methods StreamResponseFromChatbot and StreamResponseEnumerableFromChatbot.

With Async suffix it will be like StreamResponseEnumerableFromChatbotAsync, which seems too long.

In CompletionEndpoint we have CreateCompletionAsync() and StreamCompletionAsync(). So maybe this is better?

• GetResponseAsync()
• StreamResponseAsync()
• StreamResponseEnumerableAsync()

Can I modify the name of GetResponseFromChatbot() in this pull request?

[Baklap4]

ChatMessage.Content is a string so you can use var here instead of the alias string for the variable

[Baklap4]

C# 8 comes with NRT, please use it appropiatly: ChatMessageRole? responseRole = null;

[JasonWei512]

I wanted to do so, but nullable is not enabled for this project

[Baklap4]

Hmm without the nullable feature you can say: #nullable enable around your methods/classes.
The NRT feature mostly enables static analysis in this case.. You clearly assign null to the variable so why not explicitly state so? This way intent is shown and it's clear that this variable is indeed null at start.

[popyoung]

When will it be merged into a release version?

[OkGoDoIt]

I'm sorry about the inconsistent naming with Async, however I am leery of changing the names at this point because I don't want to break anything. Perhaps this can be saved for a major v2 along with other breaking changes.

As for nullable, I'm trying to keep this as backward-compatible as possible, working on .NET Standard and .NET framework as well. I don't think that can be done if I enable nullable? To be honest .NET has been changing so fast, I'm not really sure about this new nullable stuff.

[OkGoDoIt]

Thanks @JasonWei512, this is a much better implementation of streaming results from chat!