ResponseOutputItemRealtimeServerMessage Class
Definition
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.
Represents a real-time message representing a new output item added or created during response generation.
public ref class ResponseOutputItemRealtimeServerMessage : Microsoft::Extensions::AI::RealtimeServerMessage[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public class ResponseOutputItemRealtimeServerMessage : Microsoft.Extensions.AI.RealtimeServerMessagepublic class ResponseOutputItemRealtimeServerMessage : Microsoft.Extensions.AI.RealtimeServerMessage[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type ResponseOutputItemRealtimeServerMessage = class
inherit RealtimeServerMessagetype ResponseOutputItemRealtimeServerMessage = class
inherit RealtimeServerMessagePublic Class ResponseOutputItemRealtimeServerMessage
Inherits RealtimeServerMessage- Inheritance
- Attributes
Remarks
Used with the ResponseOutputItemDone and ResponseOutputItemAdded messages.
Provider implementations should emit this message with ResponseOutputItemDone when an output item (such as a function call or text message) has completed. The built-in FunctionInvokingRealtimeClientSession middleware depends on this message to detect and invoke tool calls.
Constructors
| Name | Description |
|---|---|
| ResponseOutputItemRealtimeServerMessage(RealtimeServerMessageType) |
Initializes a new instance of the ResponseOutputItemRealtimeServerMessage class. |
Properties
| Name | Description |
|---|---|
| Item |
Gets or sets the conversation item included in the response. |
| MessageId |
Gets or sets the optional message ID associated with the response. This can be used for tracking and correlation purposes. (Inherited from RealtimeServerMessage) |
| OutputIndex |
Gets or sets the unique output index. |
| RawRepresentation |
Gets or sets the raw representation of the response. This can be used to hold the original data structure received from the model. (Inherited from RealtimeServerMessage) |
| ResponseId |
Gets or sets the unique response ID. |
| Type |
Gets or sets the type of the real-time response. (Inherited from RealtimeServerMessage) |
