IChatCompletionService.GetStreamingChatMessageContentsAsync Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel.ChatCompletion

Assembly:: Microsoft.SemanticKernel.Abstractions.dll

Package:: Microsoft.SemanticKernel.Abstractions v1.20.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get streaming chat contents for the chat history provided using the specified settings.

public System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.StreamingChatMessageContent> GetStreamingChatMessageContentsAsync (Microsoft.SemanticKernel.ChatCompletion.ChatHistory chatHistory, Microsoft.SemanticKernel.PromptExecutionSettings? executionSettings = default, Microsoft.SemanticKernel.Kernel? kernel = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetStreamingChatMessageContentsAsync : Microsoft.SemanticKernel.ChatCompletion.ChatHistory * Microsoft.SemanticKernel.PromptExecutionSettings * Microsoft.SemanticKernel.Kernel * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.StreamingChatMessageContent>

Public Function GetStreamingChatMessageContentsAsync (chatHistory As ChatHistory, Optional executionSettings As PromptExecutionSettings = Nothing, Optional kernel As Kernel = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of StreamingChatMessageContent)

Parameters

chatHistory: ChatHistory

The chat history to complete.

executionSettings: PromptExecutionSettings

The AI execution settings (optional).

kernel: Kernel

The Kernel containing services, plugins, and other state for use throughout the operation.

cancellationToken: CancellationToken

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

Returns

IAsyncEnumerable<StreamingChatMessageContent>

Streaming list of different completion streaming string updates generated by the remote model

Exceptions

NotSupportedException

Throws if the specified type is not the same or fail to cast

Applies to

Share via