Class RealtimeEvent.Response

Inheritance

object

RealtimeEvent.Response

Namespace: Glitch9.AIDevKit.OpenAI.Realtime

Assembly: .dll

Syntax

public static class RealtimeEvent.Response

Fields

ConversationCreated

Returned when a conversation is created. Emitted right after session creation.

Declaration

public const string ConversationCreated = "conversation.created"

Field Value

Type	Description
string

ConversationItemCreated

Returned when a conversation item is created.

Declaration

public const string ConversationItemCreated = "conversation.item.created"

Field Value

Type	Description
string

ConversationItemDeleted

Returned when an item in the conversation is deleted.

Declaration

public const string ConversationItemDeleted = "conversation.item.deleted"

Field Value

Type	Description
string

ConversationItemInputAudioTranscriptionCompleted

Returned when input audio transcription is enabled and a transcription succeeds.

Declaration

public const string ConversationItemInputAudioTranscriptionCompleted = "conversation.item.input_audio_transcription.completed"

Field Value

Type	Description
string

ConversationItemInputAudioTranscriptionDelta

Returned when input audio transcription is enabled and a transcription delta is received.

Declaration

public const string ConversationItemInputAudioTranscriptionDelta = "conversation.item.input_audio_transcription.delta"

Field Value

Type	Description
string

ConversationItemInputAudioTranscriptionFailed

Returned when input audio transcription is configured, and a transcription request for a user message failed.

Declaration

public const string ConversationItemInputAudioTranscriptionFailed = "conversation.item.input_audio_transcription.failed"

Field Value

Type	Description
string

ConversationItemTruncated

Returned when an earlier assistant audio message item is truncated by the client.

Declaration

public const string ConversationItemTruncated = "conversation.item.truncated"

Field Value

Type	Description
string

Error

Returned when an error occurs.

Declaration

public const string Error = "error"

Field Value

Type	Description
string

InputAudioBufferCleared

Returned when the input audio buffer is cleared by the client.

Declaration

public const string InputAudioBufferCleared = "input_audio_buffer.cleared"

Field Value

Type	Description
string

InputAudioBufferCommitted

Returned when an input audio buffer is committed, either by the client or automatically in server VAD mode.

Declaration

public const string InputAudioBufferCommitted = "input_audio_buffer.committed"

Field Value

Type	Description
string

InputAudioBufferSpeechStarted

Returned in server turn detection mode when speech is detected.

Declaration

public const string InputAudioBufferSpeechStarted = "input_audio_buffer.speech_started"

Field Value

Type	Description
string

InputAudioBufferSpeechStopped

Returned in server turn detection mode when speech stops.

Declaration

public const string InputAudioBufferSpeechStopped = "input_audio_buffer.speech_stopped"

Field Value

Type	Description
string

RateLimitsUpdated

Emitted after every "response.done" event to indicate the updated rate limits.

Declaration

public const string RateLimitsUpdated = "rate_limits.updated"

Field Value

Type	Description
string

ResponseAudioDelta

Returned when the model-generated audio is updated.

Declaration

public const string ResponseAudioDelta = "response.audio.delta"

Field Value

Type	Description
string

ResponseAudioDone

Returned when the model-generated audio is done. Also emitted when a Response is interrupted, incomplete, or cancelled.

Declaration

public const string ResponseAudioDone = "response.audio.done"

Field Value

Type	Description
string

ResponseAudioTranscriptDelta

Returned when the model-generated transcription of audio output is updated.

Declaration

public const string ResponseAudioTranscriptDelta = "response.audio_transcript.delta"

Field Value

Type	Description
string

ResponseAudioTranscriptDone

Returned when the model-generated transcription of audio output is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

Declaration

public const string ResponseAudioTranscriptDone = "response.audio_transcript.done"

Field Value

Type	Description
string

ResponseContentPartAdded

Returned when a new content part is added to an assistant message item during response generation.

Declaration

public const string ResponseContentPartAdded = "response.content_part.added"

Field Value

Type	Description
string

ResponseContentPartDone

Returned when a content part is done streaming in an assistant message item. Also emitted when a Response is interrupted, incomplete, or cancelled.

Declaration

public const string ResponseContentPartDone = "response.content_part.done"

Field Value

Type	Description
string

ResponseCreated

Returned when a new Response is created. The first event of response creation, where the response is in an initial state of "in_progress".

Declaration

public const string ResponseCreated = "response.created"

Field Value

Type	Description
string

ResponseDone

Returned when a Response is done streaming. Always emitted, no matter the final state.

Declaration

public const string ResponseDone = "response.done"

Field Value

Type	Description
string

ResponseFunctionCallArgumentsDelta

Returned when the model-generated function call arguments are updated.

Declaration

public const string ResponseFunctionCallArgumentsDelta = "response.function_call_arguments.delta"

Field Value

Type	Description
string

ResponseFunctionCallArgumentsDone

Returned when the model-generated function call arguments are done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

Declaration

public const string ResponseFunctionCallArgumentsDone = "response.function_call_arguments.done"

Field Value

Type	Description
string

ResponseOutputItemAdded

Returned when a new Item is created during response generation.

Declaration

public const string ResponseOutputItemAdded = "response.output_item.added"

Field Value

Type	Description
string

ResponseOutputItemDone

Returned when an Item is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

Declaration

public const string ResponseOutputItemDone = "response.output_item.done"

Field Value

Type	Description
string

ResponseTextDelta

Returned when the text value of a "text" content part is updated.

Declaration

public const string ResponseTextDelta = "response.text.delta"

Field Value

Type	Description
string

ResponseTextDone

Returned when the text value of a "text" content part is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

Declaration

public const string ResponseTextDone = "response.text.done"

Field Value

Type	Description
string

SessionCreated

Returned when a session is created. Emitted automatically when a new connection is established.

Declaration

public const string SessionCreated = "session.created"

Field Value

Type	Description
string

SessionUpdated

Returned when a session is updated.

Declaration

public const string SessionUpdated = "session.updated"

Field Value

Type	Description
string