Edit

Share via

MicrosoftExtensionsAIChatExtensions.AsOpenAIStreamingChatCompletionUpdatesAsync Method

Definition

Namespace:
OpenAI.Chat
Assembly:
Microsoft.Extensions.AI.OpenAI.dll
Package:
Microsoft.Extensions.AI.OpenAI v10.4.0
Source:
MicrosoftExtensionsAIChatExtensions.cs

Creates a sequence of OpenAI StreamingChatCompletionUpdate instances from the specified sequence of ChatResponseUpdate instances.

[System.Diagnostics.CodeAnalysis.Experimental("OPENAI001")]
public static System.Collections.Generic.IAsyncEnumerable<OpenAI.Chat.StreamingChatCompletionUpdate> AsOpenAIStreamingChatCompletionUpdatesAsync(this System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.ChatResponseUpdate> responseUpdates, System.Threading.CancellationToken cancellationToken = default);
public static System.Collections.Generic.IAsyncEnumerable<OpenAI.Chat.StreamingChatCompletionUpdate> AsOpenAIStreamingChatCompletionUpdatesAsync(this System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.ChatResponseUpdate> responseUpdates, System.Threading.CancellationToken cancellationToken = default);
[<System.Diagnostics.CodeAnalysis.Experimental("OPENAI001")>]
static member AsOpenAIStreamingChatCompletionUpdatesAsync : System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.ChatResponseUpdate> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<OpenAI.Chat.StreamingChatCompletionUpdate>
static member AsOpenAIStreamingChatCompletionUpdatesAsync : System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.ChatResponseUpdate> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<OpenAI.Chat.StreamingChatCompletionUpdate>
<Extension()>
Public Function AsOpenAIStreamingChatCompletionUpdatesAsync (responseUpdates As IAsyncEnumerable(Of ChatResponseUpdate), Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of StreamingChatCompletionUpdate)

Parameters

responseUpdates
IAsyncEnumerable<ChatResponseUpdate>

The update instances.

cancellationToken
CancellationToken

The CancellationToken to monitor for cancellation requests. The default is None.

Returns

IAsyncEnumerable<StreamingChatCompletionUpdate>

A sequence of converted ChatResponseUpdate instances.

Attributes
ExperimentalAttribute

Exceptions

ArgumentNullException

responseUpdates is null.

Applies to