Class RealtimeEvent

Handles all the different types of Realtime API events that can be sent to or received from the OpenAI API.

Inheritance

object

RealtimeEvent

Namespace: Glitch9.AIDevKit.OpenAI.Realtime

Assembly: .dll

Syntax

public class RealtimeEvent

Properties

Arguments

The final arguments as a JSON string.

Declaration

public string Arguments { get; set; }

Property Value

Type	Description
string

Audio

Base64-encoded audio bytes.

Declaration

public string Audio { get; set; }

Property Value

Type	Description
string

Remarks

This property is only used when the event type is InputAudioBufferAppend.

AudioEndMs

Inclusive duration up to which audio is truncated, in milliseconds.

Declaration

public int? AudioEndMs { get; set; }

Property Value

Type	Description
int?

AudioStartMs

Milliseconds since the session started when speech was detected.

Declaration

public int? AudioStartMs { get; set; }

Property Value

Type	Description
int?

CallId

The ID of the function call.

Declaration

public string CallId { get; set; }

Property Value

Type	Description
string

CancellationTokenSource

Declaration

public CancellationTokenSource CancellationTokenSource { get; set; }

Property Value

Type	Description
CancellationTokenSource

ContentIndex

The index of the content part in the item's content array.

Declaration

public int? ContentIndex { get; set; }

Property Value

Type	Description
int?

Conversation

The conversation resource.

Declaration

public Conversation Conversation { get; set; }

Property Value

Type	Description
Conversation

Delta

ResponseTextDelta: The text delta.

ResponseAudioTranscriptDelta: The transcript delta.

ResponseAudioDelta: Base64-encoded audio data delta.

ResponseFunctionCallArgumentsDelta: The arguments delta as a JSON string.

Declaration

public string Delta { get; set; }

Property Value

Type	Description
string

Error

Details of the error.

Declaration

public ErrorResponse Error { get; set; }

Property Value

Type	Description
ErrorResponse

EventId

Requests: Optional client-generated ID used to identify this event.

Responses: The unique ID of the realtime event.

Declaration

public string EventId { get; set; }

Property Value

Type	Description
string

Item

The item to add to the conversation.

Declaration

public RealtimeItem Item { get; set; }

Property Value

Type	Description
RealtimeItem

ItemId

The ID of the item or the function call item.

Declaration

public string ItemId { get; set; }

Property Value

Type	Description
string

OutputIndex

The index of the output item in the response.

Declaration

public int? OutputIndex { get; set; }

Property Value

Type	Description
int?

Part

ResponseContentPartAdded: The content part that was added.

ResponseContentPartDone: The content part that is done.

Declaration

public RealtimeItemContent Part { get; set; }

Property Value

Type	Description
RealtimeItemContent

PreviousItemId

The ID of the preceding item after which the new item will be inserted.

Declaration

public string PreviousItemId { get; set; }

Property Value

Type	Description
string

RateLimits

List of rate limit information.

Declaration

public RateLimit[] RateLimits { get; set; }

Property Value

Type	Description
RateLimit[]

Response

ResponseCreate: Configuration for the response.

Declaration

public RealtimeItem Response { get; set; }

Property Value

Type	Description
RealtimeItem

ResponseId

The ID of the response.

Declaration

public string ResponseId { get; set; }

Property Value

Type	Description
string

Session

The session resource.

Declaration

public RealtimeSession Session { get; set; }

Property Value

Type	Description
RealtimeSession

Text

The final text content.

Declaration

public string Text { get; set; }

Property Value

Type	Description
string

Transcript

ResponseAudioTranscriptDone: The final transcript of the audio.

Declaration

public string Transcript { get; set; }

Property Value

Type	Description
string

Type

The event type.

Declaration

public string Type { get; set; }

Property Value

Type	Description
string