ChatResponseUpdate.MessageId Property

Definition

Gets or sets the ID of the message of which this update is a part.

public:
 property System::String ^ MessageId { System::String ^ get(); void set(System::String ^ value); };
public string? MessageId { get; set; }
member this.MessageId : string with get, set
Public Property MessageId As String

Property Value

Remarks

A single streaming response may be composed of multiple messages, each of which may be represented by multiple updates. This property is used to group those updates together into messages.

Some providers may consider streaming responses to be a single message, and in that case the value of this property may be the same as the response ID.

This value is used when ToChatResponseAsync(IAsyncEnumerable<ChatResponseUpdate>, CancellationToken) groups ChatResponseUpdate instances into ChatMessage instances. The value must be unique to each call to the underlying provider, and must be shared by all updates that are part of the same logical message within a streaming response.

Applies to