OpenAIStreamingChatMessageContent Class

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.OpenAI

Assembly:: Microsoft.SemanticKernel.Connectors.OpenAI.dll

Package:: Microsoft.SemanticKernel.Connectors.OpenAI 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.

OpenAI specialized streaming chat message content.

public sealed class OpenAIStreamingChatMessageContent : Microsoft.SemanticKernel.StreamingChatMessageContent

type OpenAIStreamingChatMessageContent = class
    inherit StreamingChatMessageContent

Public NotInheritable Class OpenAIStreamingChatMessageContent
Inherits StreamingChatMessageContent

Inheritance: Object

StreamingKernelContent

StreamingChatMessageContent
OpenAIStreamingChatMessageContent

Remarks

Represents a chat message content chunk that was streamed from the remote model.

Properties

AuthorName	Name of the author of the message (Inherited from StreamingChatMessageContent)
ChoiceIndex	In a scenario of multiple choices per request, this represents zero-based index of the choice in the streaming sequence (Inherited from StreamingKernelContent)
Content	A convenience property to get or set the text of the first item in the Items collection of StreamingTextContent type. (Inherited from StreamingChatMessageContent)
Encoding	A convenience property to get or set the encoding of the first item in the Items collection of StreamingTextContent type. (Inherited from StreamingChatMessageContent)
FinishReason	The reason why the completion finished.
InnerContent	The inner content representation. Use this to bypass the current abstraction. (Inherited from StreamingKernelContent)
Items	Chat message content items. (Inherited from StreamingChatMessageContent)
Metadata	The metadata associated with the content. (Inherited from StreamingKernelContent)
ModelId	The model ID used to generate the content. (Inherited from StreamingKernelContent)
Role	Role of the author of the message (Inherited from StreamingChatMessageContent)
ToolCallUpdates	Gets any update information in the message about a tool call.

Methods

ToByteArray()	Abstract byte[] representation of the chunk in a way it could be composed/appended with previous chunks.
ToString()	Abstract string representation of the chunk in a way it could compose/append with previous chunks.

Applies to

Share via