Class ResponseCancelRequest

Namespace

OpenAI.Realtime

Assembly

OpenAI-DotNet.dll

Send this event to cancel an in-progress response. The server will respond with a response.cancelled event or an error if there is no response to cancel.

public sealed class ResponseCancelRequest : BaseRealtimeEvent, IClientEvent, IRealtimeEvent

Inheritance

object

BaseRealtimeEvent

ResponseCancelRequest

Implements

IClientEvent

IRealtimeEvent

Inherited Members

BaseRealtimeEvent.ToJsonString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ResponseCancelRequest()

Default Constructor.

public ResponseCancelRequest()

ResponseCancelRequest(string)

Constructor.

public ResponseCancelRequest(string responseId)

Parameters

responseId string

A specific response ID to cancel - if not provided, will cancel an in-progress response in the default conversation.

Properties

EventId

The unique ID of the server event.

[JsonInclude]
[JsonPropertyName("event_id")]
public override string EventId { get; }

Property Value

string

ResponseId

A specific response ID to cancel - if not provided, will cancel an in-progress response in the default conversation.

[JsonInclude]
[JsonPropertyName("response_id")]
public string ResponseId { get; }

Property Value

string

Type

[JsonInclude]
[JsonPropertyName("type")]
public override string Type { get; protected set; }

Property Value

string