Class ConversationItemDeleteRequest

Namespace

OpenAI.Realtime

Assembly

OpenAI-DotNet.dll

Send this event when you want to remove any item from the conversation history. The server will respond with a conversation.item.deleted event, unless the item does not exist in the conversation history, in which case the server will respond with an error.

public sealed class ConversationItemDeleteRequest : BaseRealtimeEvent, IClientEvent, IRealtimeEvent

Inheritance

object

BaseRealtimeEvent

ConversationItemDeleteRequest

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

ConversationItemDeleteRequest()

public ConversationItemDeleteRequest()

ConversationItemDeleteRequest(string)

public ConversationItemDeleteRequest(string itemId)

Parameters

itemId string

Properties

EventId

The unique ID of the server event.

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

Property Value

string

ItemId

The ID of the item to delete.

[JsonInclude]
[JsonPropertyName("item_id")]
public string ItemId { get; }

Property Value

string

Type

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

Property Value

string