RealtimeResponseStatus Class

Definition

Defines well-known status values for real-time response lifecycle messages.

public ref class RealtimeResponseStatus abstract sealed
[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public static class RealtimeResponseStatus
public static class RealtimeResponseStatus
[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type RealtimeResponseStatus = class
type RealtimeResponseStatus = class
Public Class RealtimeResponseStatus
Inheritance
RealtimeResponseStatus
Attributes

Remarks

These constants represent the standard status values that may appear on Status when the response completes (i.e., on ResponseDone). Providers may use additional status values beyond those defined here.

Properties

Name Description
Cancelled

Gets the status value indicating the response was cancelled, typically due to an interruption such as user barge-in (the user started speaking while the model was generating output).

Completed

Gets the status value indicating the response completed successfully.

Failed

Gets the status value indicating the response failed due to an error.

Incomplete

Gets the status value indicating the response ended before completing, for example because the output reached the maximum token limit.

Applies to