Class RealtimeEvent.Client.Conversation.Item

Inheritance

object

RealtimeEvent.Client.Conversation.Item

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Glitch9.AIDevKit.OpenAI.Realtime

Assembly: Glitch9.AIDevKit.Provider.OpenAI.dll

Syntax

public static class RealtimeEvent.Client.Conversation.Item

Fields

Create

Send this event when adding an item to the conversation.

Declaration

public const string Create = "conversation.item.create"

Field Value

Type	Description
string

Delete

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.

Declaration

public const string Delete = "conversation.item.delete"

Field Value

Type	Description
string

Retrieve

Send this event when you want to retrieve the server's representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD. The server will respond with a conversation.item.retrieved event, unless the item does not exist in the conversation history, in which case the server will respond with an error.

Declaration

public const string Retrieve = "conversation.item.retrieve"

Field Value

Type	Description
string

Truncate

Send this event to truncate a previous assistant message???audio. The server will produce audio faster than realtime, so this event is useful when the user interrupts to truncate audio that has already been sent to the client but not yet played. This will synchronize the server's understanding of the audio with the client's playback.

Truncating audio will delete the server-side text transcript to ensure there is not text in the context that hasn't been heard by the user.

If successful, the server will respond with a conversation.item.truncated event.

Declaration

public const string Truncate = "conversation.item.truncate"

Field Value

Type	Description
string