ITextGenerationService.GetStreamingTextContentsAsync Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel.TextGeneration

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 results for the prompt using the specified execution settings. Each modality may support for different types of streaming contents.

public System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.StreamingTextContent> GetStreamingTextContentsAsync (string prompt, Microsoft.SemanticKernel.PromptExecutionSettings? executionSettings = default, Microsoft.SemanticKernel.Kernel? kernel = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetStreamingTextContentsAsync : string * Microsoft.SemanticKernel.PromptExecutionSettings * Microsoft.SemanticKernel.Kernel * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.StreamingTextContent>

Public Function GetStreamingTextContentsAsync (prompt As String, Optional executionSettings As PromptExecutionSettings = Nothing, Optional kernel As Kernel = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of StreamingTextContent)

Parameters

prompt: String

The prompt 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<StreamingTextContent>

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

Remarks

Usage of this method with value types may be more efficient if the connector supports it.

Applies to

通过