Class StatusDetails

Namespace

OpenAI.Realtime

Assembly

OpenAI-DotNet.dll

public sealed class StatusDetails

Inheritance

object

StatusDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Error

A description of the error that caused the response to fail, populated when the status is failed.

[JsonInclude]
[JsonPropertyName("error")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public Error Error { get; }

Property Value

Error

Reason

The reason the Response did not complete. For a cancelled Response, one of turn_detected (the server VAD detected a new start of speech) or client_cancelled (the client sent a cancel event). For an incomplete Response, one of max_output_tokens or content_filter (the server-side safety filter activated and cut off the response).

[JsonInclude]
[JsonPropertyName("reason")]
public string Reason { get; }

Property Value

string

Type

The type of error that caused the response to fail, corresponding with the status field (cancelled, incomplete, failed).

[JsonInclude]
[JsonPropertyName("type")]
[JsonConverter(typeof(JsonStringEnumConverter<RealtimeResponseStatus>))]
public RealtimeResponseStatus Type { get; }

Property Value

RealtimeResponseStatus